justrouting

package module

Go to main page

Versions in this module

v0

v0.3.2

Oct 22, 2026

Changes in this version

+ type Break struct

+ Description string

+ ID int

+ MaxLoad []int

+ Service int

+ TimeWindows []TimeWindow

+ type CustomMatrix struct

+ Costs [][]int

+ Distances [][]int

+ Durations [][]int

type GeocodeResult

+ District string

type Job

+ LocationIndex *int

+ ServicePerType map[string]int

+ SetupPerType map[string]int

type MapMatchingRequest

+ Approaches []string

+ Bearings []string

+ GenerateHints *bool

+ Hints []string

+ SkipWaypoints bool

type MatrixRequest

+ Approaches []string

+ Bearings []string

+ Exclude []string

+ FallbackCoordinate string

+ FallbackSpeed *float64

+ GenerateHints *bool

+ Hints []string

+ Radiuses []string

+ ScaleFactor *float64

+ SkipWaypoints bool

+ Snapping string

type MatrixResponse

+ FallbackSpeedCells [][]int

type NearestRequest

+ Approaches []string

+ Bearings []string

+ GenerateHints *bool

+ Hints []string

+ Radiuses []string

+ SkipWaypoints bool

+ Snapping string

type OptimizationRequest

+ Matrices map[string]CustomMatrix

type RouteRequest

+ Approaches []string

+ Bearings []string

+ GenerateHints *bool

+ Hints []string

+ Radiuses []string

+ SkipWaypoints bool

+ Snapping string

+ WaypointIndices []int

type RouteResponse

+ DataVersion string

type RouteStep

+ LocationIndex int

+ Violations []Violation

type ShipmentStep

+ LocationIndex *int

+ ServicePerType map[string]int

+ SetupPerType map[string]int

type Summary

+ Violations []Violation

type TripRequest

+ Approaches []string

+ Bearings []string

+ GenerateHints *bool

+ Hints []string

+ Radiuses []string

+ SkipWaypoints bool

+ Snapping string

type Unassigned

+ LocationIndex int

type Vehicle

+ Breaks []Break

+ Costs *VehicleCosts

+ EndIndex *int

+ MaxDistance int

+ MaxTravelTime int

+ SpeedFactor float64

+ StartIndex *int

+ Steps []VehicleStep

+ Type string

+ type VehicleCosts struct

+ Fixed int

+ PerHour int

+ PerKM int

+ PerTaskHour int

type VehicleRoute

+ Description string

+ Violations []Violation

+ type VehicleStep struct

+ ID int

+ Type string

+ type Violation struct

+ Cause string

+ Duration int

type Waypoint

+ TripsIndex int

+ WaypointIndex int

v0.3.1

Oct 5, 2026

Changes in this version

type Intersection

+ Classes []string

v0.3.0

Sep 24, 2026

Changes in this version

type Client

+ MapMatching *MapMatchingService

+ Nearest *NearestService

+ Trip *TripService

+ type MapMatchingRequest struct

+ Annotations []string

+ Coordinates []Point

+ Exclude []string

+ Gaps string

+ Geometries string

+ Overview string

+ Profile string

+ Radiuses []float64

+ Snapping string

+ Steps bool

+ Tidy bool

+ Timestamps []int64

+ Waypoints []int

+ type MapMatchingResponse struct

+ Code string

+ Matchings []*Match

+ Message string

+ Tracepoints []*Tracepoint

+ type MapMatchingService struct

+ func (s *MapMatchingService) Get(ctx context.Context, req *MapMatchingRequest) (*Match, error)

+ func (s *MapMatchingService) GetAll(ctx context.Context, req *MapMatchingRequest) (*MapMatchingResponse, error)

+ type Match struct

+ Confidence float64

+ type NearestRequest struct

+ Coordinate Point

+ Exclude []string

+ Number int

+ Profile string

+ type NearestResponse struct

+ Code string

+ Message string

+ Waypoints []*Waypoint

+ type NearestService struct

+ func (s *NearestService) Get(ctx context.Context, req *NearestRequest) (*Waypoint, error)

+ func (s *NearestService) GetAll(ctx context.Context, req *NearestRequest) (*NearestResponse, error)

+ type Tracepoint struct

+ AlternativesCount int

+ Distance float64

+ Hint string

+ Location Point

+ MatchingsIndex int

+ Name string

+ WaypointIndex int

+ type TripRequest struct

+ Annotations []string

+ Coordinates []Point

+ Destination string

+ Exclude []string

+ Geometries string

+ Overview string

+ Profile string

+ Roundtrip *bool

+ Source string

+ Steps bool

+ type TripResponse struct

+ Code string

+ Message string

+ Trips []*Route

+ Waypoints []*Waypoint

+ type TripService struct

+ func (s *TripService) Get(ctx context.Context, req *TripRequest) (*Route, error)

+ func (s *TripService) GetAll(ctx context.Context, req *TripRequest) (*TripResponse, error)

type Waypoint

+ Nodes []int64

v0.2.0

Sep 23, 2026

Changes in this version

+ type BBox struct

+ Lat1 float64

+ Lat2 float64

+ Lon1 float64

+ Lon2 float64

type Client

+ Geocode *GeocodeService

+ type Datasource struct

+ Attribution string

+ License string

+ Sourcename string

+ URL string

+ type GeocodeQuery struct

+ Parsed json.RawMessage

+ Text string

+ type GeocodeRequest struct

+ Bias string

+ Filters []string

+ Lang string

+ Limit int

+ Offset int

+ Structured *StructuredQuery

+ Text string

+ Type string

+ type GeocodeResponse struct

+ Query *GeocodeQuery

+ Results []*GeocodeResult

+ type GeocodeResult struct

+ AddressLine1 string

+ AddressLine2 string

+ BBox BBox

+ Category string

+ City string

+ Country string

+ CountryCode string

+ County string

+ Datasource Datasource

+ Distance float64

+ Formatted string

+ Housenumber string

+ Lat float64

+ Lon float64

+ Name string

+ PlaceID string

+ PlusCode string

+ Postcode string

+ Rank Rank

+ ResultType string

+ State string

+ StateCode string

+ Street string

+ Suburb string

+ Timezone Timezone

+ func (r *GeocodeResult) Location() Point

+ type GeocodeService struct

+ func (s *GeocodeService) Search(ctx context.Context, req *GeocodeRequest) (*GeocodeResponse, error)

+ type Rank struct

+ Confidence float64

+ ConfidenceCityLevel float64

+ ConfidenceStreetLevel float64

+ Importance float64

+ MatchType string

+ Popularity float64

+ type StructuredQuery struct

+ City string

+ Country string

+ Housenumber string

+ Name string

+ Postcode string

+ State string

+ Street string

+ type Timezone struct

+ AbbreviationDST string

+ AbbreviationSTD string

+ Name string

+ OffsetDST string

+ OffsetDSTSeconds int

+ OffsetSTD string

+ OffsetSTDSeconds int

v0.1.1

Sep 16, 2026

v0.1.0

Aug 29, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultProfile

+ const Version

+ var ErrCrossCountry = errors.New("justrouting: cross-country request not supported")

+ var ErrInvalidCoordinates = errors.New("justrouting: invalid coordinates")

+ var ErrInvalidRequest = errors.New("justrouting: invalid request")

+ var ErrNoRoute = errors.New("justrouting: no route found")

+ var ErrPlanLimitExceeded = errors.New("justrouting: plan limit exceeded")

+ var ErrQuotaExceeded = errors.New("justrouting: daily quota exceeded")

+ var ErrRateLimited = errors.New("justrouting: rate limit exceeded")

+ var ErrUnauthorized = errors.New("justrouting: unauthorized")

+ var ErrUpstreamUnavailable = errors.New("justrouting: upstream unavailable")

+ type Annotation struct

+ Datasources []int

+ Distance []float64

+ Duration []float64

+ Nodes []int64

+ Speed []float64

+ Weight []float64

+ type Client struct

+ Health *HealthService

+ Matrix *MatrixService

+ Optimization *OptimizationService

+ Routes *RoutesService

+ func NewClient(apiKey string, opts ...ClientOption) *Client

+ func (c *Client) BaseURL() string

+ type ClientOption func(*Client) error

+ func WithBackoff(fn func(attempt int) time.Duration) ClientOption

+ func WithBaseURL(raw string) ClientOption

+ func WithHTTPClient(hc *http.Client) ClientOption

+ func WithMaxRetries(n int) ClientOption

+ func WithUserAgent(ua string) ClientOption

+ type Error struct

+ Body []byte

+ Message string

+ OSRMCode string

+ StatusCode int

+ VROOMCode int

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ type Geometry struct

+ func (g *Geometry) UnmarshalJSON(b []byte) error

+ func (g Geometry) GeoJSON() (*LineString, error)

+ func (g Geometry) IsZero() bool

+ func (g Geometry) MarshalJSON() ([]byte, error)

+ func (g Geometry) Polyline() (string, error)

+ func (g Geometry) Raw() json.RawMessage

+ type Health struct

+ Status string

+ Timestamp string

+ Upstreams map[string]bool

+ func (h *Health) OK() bool

+ type HealthService struct

+ func (s *HealthService) Get(ctx context.Context) (*Health, error)

+ type Intersection struct

+ Bearings []int

+ Entry []bool

+ In *int

+ Lanes []Lane

+ Location Point

+ Out *int

+ type Job struct

+ Delivery []int

+ Description string

+ ID int

+ Location Point

+ Pickup []int

+ Priority int

+ Service int

+ Setup int

+ Skills []int

+ TimeWindows []TimeWindow

+ type Lane struct

+ Indications []string

+ Valid bool

+ type Leg struct

+ Annotation *Annotation

+ Distance float64

+ Duration float64

+ Steps []*Step

+ Summary string

+ Weight float64

+ type LineString struct

+ Coordinates []Point

+ Type string

+ type Maneuver struct

+ BearingAfter int

+ BearingBefore int

+ Exit int

+ Location Point

+ Modifier string

+ Type string

+ type MatrixRequest struct

+ Annotations []string

+ Coordinates []Point

+ Destinations []int

+ Profile string

+ Sources []int

+ type MatrixResponse struct

+ Code string

+ Destinations []*Waypoint

+ Distances [][]*float64

+ Durations [][]*float64

+ Message string

+ Sources []*Waypoint

+ func (r *MatrixResponse) Distance(i, j int) (float64, bool)

+ func (r *MatrixResponse) Duration(i, j int) (float64, bool)

+ type MatrixService struct

+ func (s *MatrixService) Get(ctx context.Context, req *MatrixRequest) (*MatrixResponse, error)

+ type OptimizationOptions struct

+ Geometry bool

+ type OptimizationRequest struct

+ Jobs []Job

+ Options *OptimizationOptions

+ Shipments []Shipment

+ Vehicles []Vehicle

+ type OptimizationService struct

+ func (s *OptimizationService) Solve(ctx context.Context, req *OptimizationRequest) (*Solution, error)

+ type Point []float64

+ func (p Point) Lat() float64

+ func (p Point) Lon() float64

+ func (p Point) String() string

+ func (p Point) Validate() error

+ type Route struct

+ Distance float64

+ Duration float64

+ Geometry Geometry

+ Legs []*Leg

+ Weight float64

+ WeightName string

+ type RouteRequest struct

+ Alternatives int

+ Annotations []string

+ ContinueStraight *bool

+ Destination Point

+ Exclude []string

+ Geometries string

+ Origin Point

+ Overview string

+ Profile string

+ Steps bool

+ Waypoints []Point

+ type RouteResponse struct

+ Code string

+ Message string

+ Routes []*Route

+ Waypoints []*Waypoint

+ type RouteStep struct

+ Arrival int

+ Description string

+ Distance int

+ Duration int

+ ID int

+ Job int

+ Load []int

+ Location Point

+ Service int

+ Setup int

+ Type string

+ WaitingTime int

+ type RoutesService struct

+ func (s *RoutesService) Get(ctx context.Context, req *RouteRequest) (*Route, error)

+ func (s *RoutesService) GetAll(ctx context.Context, req *RouteRequest) (*RouteResponse, error)

+ type Shipment struct

+ Amount []int

+ Delivery ShipmentStep

+ Pickup ShipmentStep

+ Priority int

+ Skills []int

+ type ShipmentStep struct

+ Description string

+ ID int

+ Location Point

+ Service int

+ Setup int

+ TimeWindows []TimeWindow

+ type Solution struct

+ Code int

+ Error string

+ Routes []*VehicleRoute

+ Summary Summary

+ Unassigned []*Unassigned

+ type Step struct

+ Distance float64

+ Duration float64

+ Geometry Geometry

+ Intersections []*Intersection

+ Maneuver Maneuver

+ Mode string

+ Name string

+ Ref string

+ Weight float64

+ type Summary struct

+ Cost int

+ Delivery []int

+ Distance int

+ Duration int

+ Pickup []int

+ Priority int

+ Routes int

+ Service int

+ Setup int

+ Unassigned int

+ WaitingTime int

+ type TimeWindow [2]int

+ type Unassigned struct

+ Description string

+ ID int

+ Location Point

+ Type string

+ type Vehicle struct

+ Capacity []int

+ Description string

+ End Point

+ ID int

+ MaxTasks int

+ Profile string

+ Skills []int

+ Start Point

+ TimeWindow *TimeWindow

+ type VehicleRoute struct

+ Cost int

+ Delivery []int

+ Distance int

+ Duration int

+ Geometry string

+ Pickup []int

+ Priority int

+ Service int

+ Setup int

+ Steps []*RouteStep

+ Vehicle int

+ WaitingTime int

+ type Waypoint struct

+ Distance float64

+ Hint string

+ Location Point

+ Name string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL