pmtiles/org.maplibre.spatialk.pmtiles

Package-level declarations

Core PMTiles reader and writer APIs, archive metadata models, byte-range source contracts, append-only byte sink contracts, tile range lookup, and tile byte access.

Types

ArchiveHeader

data class ArchiveHeader

Parsed PMTiles v3 header.

ArchiveLimits

class ArchiveLimits

Operational limits for PMTiles archive reads.

ArchiveMetadata

data class ArchiveMetadata

Typed PMTiles metadata fields.

ArchiveOpenOptions

class ArchiveOpenOptions

Options used when opening a PMTiles archive.

ArchiveSection

data class ArchiveSection

Header section location and size.

ArchiveTile

data class ArchiveTile

Tile payload returned by the archive reader.

ArchiveWarning

data class ArchiveWarning

Warning recorded by a lenient archive operation.

ArchiveWarningCode

@JvmInline

value class ArchiveWarningCode(val code: UInt)

Warning code recorded by lenient archive operations.

ArchiveWarningCodes

object ArchiveWarningCodes

Archive warning-code constants.

ArchiveWriteBounds

data class ArchiveWriteBounds(val west: Double, val south: Double, val east: Double, val north: Double)

Geographic longitude/latitude bounds used when writing an archive header.

ArchiveWriteCenter

data class ArchiveWriteCenter(val longitude: Double, val latitude: Double, val zoom: Int)

Geographic center point used when writing an archive header.

ArchiveWriteConfig

class ArchiveWriteConfig

Header and metadata configuration for PMTiles archive writing.

ArchiveWriteLimits

class ArchiveWriteLimits

Operational limits for PMTiles archive writes.

ArchiveWriteOptions

class ArchiveWriteOptions

Options used when writing a PMTiles archive.

ArchiveWriteTile

data class ArchiveWriteTile(val coord: TileCoord, val payload: ByteString, val payloadMode: TilePayloadMode)

Tile payload input for PMTiles archive writing.

ByteRange

data class ByteRange

Absolute byte range in a PMTiles archive.

ByteRangeSource

@ObjCName(swiftName = "__KotlinByteRangeSource")

interface ByteRangeSource

Caller-provided byte range source used by the PMTiles reader.

ByteSink

@ObjCName(swiftName = "__KotlinByteSink")

interface ByteSink

Caller-provided append-only byte sink used by the PMTiles writer.

CompressionCode

@JvmInline

value class CompressionCode(val code: UInt)

PMTiles compression code.

CompressionCodes

object CompressionCodes

PMTiles compression-code constants.

CompressionLimits

data class CompressionLimits

Compression byte limits passed to compressor implementations.

Compressor

@ObjCName(swiftName = "__KotlinCompressor")

fun interface Compressor

Compresses bytes for one PMTiles compression format.

DecompressionLimits

data class DecompressionLimits

Decompressed byte limits passed to decompressor implementations.

Decompressor

@ObjCName(swiftName = "__KotlinDecompressor")

fun interface Decompressor

Decompresses bytes for one PMTiles compression format.

HeaderCounts

data class HeaderCounts

PMTiles header counts.

LonLatBounds

data class LonLatBounds

Geographic longitude/latitude bounds.

PmTiles

object PmTiles

Factory methods for PMTiles archives.

PmTilesArchive

class PmTilesArchive : AutoCloseable

Open PMTiles archive reader.

PmTilesErrorCode

@JvmInline

value class PmTilesErrorCode(val code: UInt)

Stable error code emitted by PMTiles archive operations.

PmTilesErrorCodes

object PmTilesErrorCodes

PMTiles error-code constants.

PmTilesException

class PmTilesException(val code: PmTilesErrorCode, message: String, cause: Throwable? = null) : Exception

Error thrown by PMTiles archive operations.

TileCenter

data class TileCenter

Geographic center point and zoom.

TileCoord

data class TileCoord(val z: Int, val x: Int, val y: Int)

Web tile coordinate.

TileIds

@HiddenFromObjC

object TileIds

PMTiles TileID conversion utilities.

TilePayloadMode

@JvmInline

value class TilePayloadMode(val code: UInt)

How ArchiveWriteTile.payload bytes should be interpreted by the writer.

TilePayloadModes

object TilePayloadModes

Tile payload mode constants.

TileRange

data class TileRange

Located tile byte range.

TileReadCoalescing

class TileReadCoalescing

Controls source-range coalescing for batch tile reads.

TileReadResult

data class TileReadResult

Result for one coordinate in a batch tile read.

TileTypeCode

@JvmInline

value class TileTypeCode(val code: UInt)

PMTiles tile type code.

TileTypeCodes

object TileTypeCodes

PMTiles tile-type-code constants.

ValidationMode

enum ValidationMode : Enum<ValidationMode>

Archive validation mode.