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

Container

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

A container provides access to a list of Readable entries.

Inheritors

CompositeContainer

DirectoryContainer

SingleResourceContainer

TransformingContainer

Properties

abstract val entries: Set<Url>

List of all the container entries.

open val sourceUrl: AbsoluteUrl?

Direct source to this container, when available.

Functions

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 operator fun get(url: Url): E?

Returns the entry at the given url or null if there is none.

open operator override fun iterator(): Iterator<Url>

readDecodeOrNull

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