PersistentMapStatus

public enum PersistentMapStatus : UInt32, CaseIterable, Codable

Specifies possible statuses of the already downloaded map regions as a whole. Note: This can be valid only for a single region in case of a PersistentMapStatus.corrupted state.

  • ok

    All downloaded regions are in a workable state, no issues found.

    Declaration

    Swift

    case ok

  • One or more downloaded regions failed to open and a repair action should be performed to mitigate this issue. All map download and map update operations (except for sdk.maploader.MapDownloader.repair_persistent_map) will return sdk.maploader.MapLoaderError.NOT_READY.

    Declaration

    Swift

    case corrupted

  • Unrecoverable error during construction of pending update parameters. Operations such as catalog updates or region downloads will fail. The healing procedure is to clean persistent map with sdk.maploader.MapDownloader.clear_persistent_map_storage.

    Declaration

    Swift

    case brokenUpdate

  • Indicates that the downloaded regions need to be migrated to a new internal format by calling sdk.maploader.MapDownloader.repair_persistent_map. This error is not a result of a data loss, nor any data will be lost when performing the repair operation and the map version will stay unchanged afterwards.

    Declaration

    Swift

    case migrationNeeded

  • A map update operation initiated by a user has been interrupted. Calls to sdk.maploader.MapDownloader.download_regions and sdk.maploader.MapDownloader.delete_regions will fail with sdk.maploader.MapLoaderError.INTERNAL_ERROR. To repair a map, call again sdk.maploader.MapUpdater.update_catalog for the affected catalog. sdk.maploader.MapUpdater.retrieve_catalogs_update_info returns a list of sdk.maploader.CatalogUpdateInfo items: The affected catalog can be identified by the state, which is set to sdk.maploader.CatalogUpdateState.PENDING_UPDATE. To know if a map needs to be repaired, check if sdk.maploader.MapLoaderError.PENDING_UPDATE has occurred.

    Declaration

    Swift

    case pendingUpdate

  • Unreachable SDKOptions.cachePath or SDKOptions.persistentMapStoragePath. Make sure that SDKOptions has accessible SDKOptions.cachePath and SDKOptions.persistentMapStoragePath

    Declaration

    Swift

    case invalidPath

  • Unrecoverable error during construction of internal map access object. The healing procedure is to clean persistent map with sdk.maploader.MapDownloader.clear_persistent_map_storage.

    Declaration

    Swift

    case invalidState

  • Indicates that the status cannot be retrieved as the map storage is already closed due to disposal of SDKNativeEngine.

    Declaration

    Swift

    case storageClosed