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

Package-level declarations

Types

AbsoluteUrl

class AbsoluteUrl : Url

Represents an absolute Uniform Resource Locator.

Closeable

interface Closeable

A Closeable is an object holding closeable resources, such as open files or streams.

CoroutineQueue

class CoroutineQueue(dispatcher: CoroutineDispatcher = Dispatchers.Main)

CoroutineScope-like util to execute coroutines in a sequential order (FIFO). As with a SupervisorJob, children can be cancelled or fail independently one from the other.

CursorList

class CursorList<E>(list: List<E> = emptyList(), index: Int = -1) : List<E>

A List with a mutable cursor index.

DebugError

class DebugError(val message: String, val cause: Error? = null) : Error

A basic Error implementation with a debug message.

Either

sealed class Either<out A, out B>

Generic wrapper to store two mutually exclusive types.

Error

interface Error

Describes an error.

ErrorException

class ErrorException(val error: Error) : Exception

A throwable caused by an Error.

FileExtension

@JvmInline

value class FileExtension(val value: String)

Instant

@Serializable(with = InstantSerializer::class)

class Instant : Parcelable, Comparable<Instant>

A moment in time.

InstantSerializer

object InstantSerializer : KSerializer<Instant>

A serializer for Instant that uses the ISO-8601 representation.

Language

@Serializable(with = Language.Serializer::class)

class Language(code: String)

Represents a language with its region.

MapCompanion

open class MapCompanion<K, E>(map: Map<K, E>)

Encapsulates a Map into a more limited query API.

MapWithDefaultCompanion

open class MapWithDefaultCompanion<K, E>(map: Map<K, E>, val default: E) : MapCompanion<K, E>

Extends a MapCompanion by adding a default value as a fallback.

MemoryObserver

interface MemoryObserver

A memory observer reacts to a device reclaiming memory by releasing unused resources.

RelativeUrl

class RelativeUrl : Url

Represents a relative Uniform Resource Locator.

SingleJob

class SingleJob(scope: CoroutineScope)

Runs a single coroutine job at a time.

ThrowableError

class ThrowableError<E : Throwable>(val throwable: E) : Error

An error caused by the catch of a throwable.

Try

sealed class Try<out Success, out Failure>

A Result type which can be used as a return type.

Url

sealed class Url : Parcelable

A Uniform Resource Locator.

Properties

isLazyInitialized

val KProperty0<*>.isLazyInitialized: Boolean

Returns true if a lazy property reference has been initialized, or if the property is not lazy.

Functions

appendToFilename

fun FileExtension?.appendToFilename(filename: String): String

Appends this file extension to filename.

checkSuccess

fun <S, F> Try<S, F>.checkSuccess(): S

Returns value in case of success and throws an IllegalStateException in case of failure.

flatMap

inline fun <R, S, F> Try<S, F>.flatMap(transform: (value: S) -> Try<R, F>): Try<R, F>

Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents success or the original encapsulated value if it is failure.

fromEpubHref

fun Url.Companion.fromEpubHref(href: String): Url?

According to the EPUB specification, the HREFs in the EPUB package must be valid URLs (so percent-encoded). Unfortunately, many EPUBs don't follow this rule, and use invalid HREFs such as my chapter.html or /dir/my chapter.html.

fromLegacyHref

fun Url.Companion.fromLegacyHref(href: String): Url?

Creates an Url from a legacy HREF.

getEquivalent

fun <T> Map<Url, T>.getEquivalent(key: Url): T?

Returns the value of the first key matching key after normalization.

getOrDefault

fun <R, S : R, F> Try<S, F>.getOrDefault(defaultValue: R): R

Returns the encapsulated value if this instance represents success or the defaultValue if it is failure.

getOrElse

inline fun <R, S : R, F> Try<S, F>.getOrElse(onFailure: (exception: F) -> R): R

Returns the encapsulated value if this instance represents success or the result of onFailure function for the encapsulated value if it is failure.

getOrThrow

fun <S, F : Throwable> Try<S, F>.getOrThrow(): S

Returns the encapsulated value if this instance represents success or throws the encapsulated Throwable exception if it is failure.

isEquivalent

fun Url?.isEquivalent(url: Url?): Boolean

Returns whether the receiver is equivalent to the given url after normalization.

toAbsoluteUrl

fun Uri.toAbsoluteUrl(): AbsoluteUrl?

fun URL.toAbsoluteUrl(): AbsoluteUrl?

toDebugDescription

fun Error.toDebugDescription(): String

Convenience function to get the description of an error with its cause.

toRelativeUrl

fun Uri.toRelativeUrl(): RelativeUrl?

fun URL.toRelativeUrl(): RelativeUrl?

toUri

fun Url.toUri(): Uri

toUrl

fun Uri.toUrl(): Url?

fun URI.toUrl(): Url?

fun URL.toUrl(): Url?

fun File.toUrl(isDirectory: Boolean): AbsoluteUrl

Creates a URL pointing to this File which must denote an absolute path.

tryRecover

inline fun <R, S : R, F, T> Try<S, F>.tryRecover(transform: (exception: F) -> Try<R, T>): Try<R, T>

Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents failure or the original encapsulated value if it is success.

use

inline fun <T : Closeable?, R> T.use(block: (T) -> R): R

Executes the given block function on this resource and then closes it down correctly whether an exception is thrown or not.