pmtiles/org.maplibre.spatialk.pmtiles/PmTilesArchive

PmTilesArchive

class PmTilesArchive : AutoCloseable(source)

Open PMTiles archive reader.

Properties

header

val header: ArchiveHeader

Parsed PMTiles header.

internalCompression

@ShouldRefineInSwift

val internalCompression: CompressionCode

CompressionCode used for directories and metadata.

tileCompression

@ShouldRefineInSwift

val tileCompression: CompressionCode

CompressionCode used for tile payloads.

tileType

@ShouldRefineInSwift

val tileType: TileTypeCode

Tile payload type from the header.

warnings

val warnings: List<ArchiveWarning>

Snapshot of warnings recorded by this archive.

Functions

open override fun close()

Releases archive-owned caches and in-flight work.

containsTile

@HiddenFromObjC

suspend fun containsTile(tileId: Long): Boolean

Returns true when the archive contains tileId.

@HiddenFromObjC

suspend fun containsTile(coord: TileCoord): Boolean

Returns true when the archive contains coord.

@HiddenFromObjC

suspend fun containsTile(z: Int, x: Int, y: Int): Boolean

Returns true when the archive contains a tile at z, x, and y.

findTileRange

suspend fun findTileRange(tileId: Long): TileRange?

Returns the archive byte range for tileId.

suspend fun findTileRange(coord: TileCoord): TileRange?

Returns the archive byte range for coord.

suspend fun findTileRange(z: Int, x: Int, y: Int): TileRange?

Returns the archive byte range for the tile at z, x, and y.

metadata

suspend fun metadata(): ArchiveMetadata

Returns typed PMTiles metadata fields.

rawMetadataJson

suspend fun rawMetadataJson(): String

Returns the raw metadata JSON string.

readDecompressedTile

suspend fun readDecompressedTile(tileId: Long): ArchiveTile?

Returns decompressed tile bytes for tileId, or null when absent.

suspend fun readDecompressedTile(coord: TileCoord): ArchiveTile?

Returns decompressed tile bytes for coord, or null when absent.

suspend fun readDecompressedTile(z: Int, x: Int, y: Int): ArchiveTile?

Returns decompressed tile bytes for the tile at z, x, and y.

readDecompressedTiles

@ShouldRefineInSwift

suspend fun readDecompressedTiles(coords: List<TileCoord>, coalescing: TileReadCoalescing = TileReadCoalescing()): List<TileReadResult>

Returns decompressed tile read results for coords, preserving input order.

readStoredTile

suspend fun readStoredTile(tileId: Long): ArchiveTile?

Returns stored tile bytes for tileId, or null when absent.

suspend fun readStoredTile(coord: TileCoord): ArchiveTile?

Returns stored tile bytes for coord, or null when absent.

suspend fun readStoredTile(z: Int, x: Int, y: Int): ArchiveTile?

Returns stored tile bytes for the tile at z, x, and y, or null when absent.

readStoredTiles

@ShouldRefineInSwift

suspend fun readStoredTiles(coords: List<TileCoord>, coalescing: TileReadCoalescing = TileReadCoalescing()): List<TileReadResult>

Returns stored tile read results for coords, preserving input order.