compass-geocoder/dev.jordond.compass.geocoder

Package-level declarations

Types

Provides geocoding operations:

sealed interface GeocoderResult<out T>

Represents the result of a geocoding operation.

A no-op PlatformGeocoder that is used when the platform does not support geocoding.

Wrapper for platform-specific geocoding services.

Get a list of Coordinatess for a given address or null if unsuccessful.

Get a Coordinates for a given address or null if unsuccessful.

fun ForwardGeocoder(platformGeocoder: PlatformGeocoder, dispatcher: CoroutineDispatcher = Dispatchers.Default): ForwardGeocoder

Create a new ForwardGeocoder using the provided PlatformGeocoder.

fun Geocoder(platformGeocoder: PlatformGeocoder, dispatcher: CoroutineDispatcher = Dispatchers.Default): Geocoder

Create a new Geocoder instance for geocoding operations.

Geocode a Coordinates to a Place or null if unsuccessful.

suspend fun Geocoder.placeOrNull(latitude: Double, longitude: Double): Place?

Geocode a pair of coordinates to a Place or null if unsuccessful.

Geocode a Coordinates to a list of Places or null if unsuccessful.

suspend fun Geocoder.placesOrNull(latitude: Double, longitude: Double): List<Place>?

Geocode a pair of coordinates to a list of Places or null if unsuccessful.

fun ReverseGeocoder(platformGeocoder: PlatformGeocoder, dispatcher: CoroutineDispatcher = Dispatchers.Default): ReverseGeocoder

Create a new ReverseGeocoder using the provided PlatformGeocoder.