Skip to main content

Crate pickpoint

Crate pickpoint 

Source
Expand description

Official Rust SDK for Pickpoint.

  • HTTP public API: geocoding, address search, routing, devices, client-tokens
  • Live GPS: tracking (WebSocket, tracking.v2)

Modules§

tracking
Realtime tracking client (binary WebSocket, tracking.v2).

Structs§

AddressApi
Address search service (GET /v2/address/search).
ApiError
Non-2xx public-api response (or transport failure after retries).
AuthError
Auth failed (401 / 402 / 403 / refresh failed).
Client
Unified public-api client (geocoding, address, routing, devices).
ClientAuth
Pair from POST /v2/client-tokens (via your backend). expires_at is unix epoch milliseconds.
Config
Configures the public-api client. Provide exactly one of api_key, client_auth, or access_token.
ConflictError
Conflict (409), e.g. device offline for command.
Device
Public-api device row.
DeviceCommandResult
POST /v2/devices/{uid}/command response.
DeviceInput
Create/update body.
DeviceListQuery
Optional list filters.
DeviceListResult
GET /v2/devices response.
DevicesApi
Devices service (/v2/devices*).
GeocodingApi
Geocoding service (/v2/geocode/*, /v2/address/lookup).
InvalidConfigError
Invalid client configuration.
NotFoundError
Resource not found (404).
RoutingApi
Routing service (Valhalla proxies under /v2/route*).
TokenPair
Response from POST /v2/client-tokens.

Enums§

Error
SDK error type for the HTTP public API.

Constants§

DEFAULT_BASE_URL
Default public API base URL.
DEFAULT_CONCURRENCY
Default parallel geocode batch requests.
DEFAULT_MAX_RETRIES
Default max retries for 5xx / network errors.
DEFAULT_RETRY_BASE
Default exponential backoff base.
DEFAULT_TIMEOUT
Default per-attempt timeout.
MAX_CONCURRENCY
Max parallel geocode batch requests.
MIN_RETRY_BASE
Minimum retry base.

Functions§

mint_client_tokens
Mint a client-token pair with a secret API key (server-side). Pass empty scopes to grant all client-tokenable permissions on the key.
query
Helper to build a Query from string pairs.

Type Aliases§

Query
Loose query-string map for geocode / address endpoints.
Result