provider

Documentation

Index

• Constants
• func AppendLeafletFlags(fs *flag.FlagSet) error
• func AppendProtomapsProviderFlags(fs *flag.FlagSet) error
• func AppendProviderFlags(fs *flag.FlagSet) error
• func LeafletOptionsFromURL(u *url.URL) (*leaflet.LeafletOptions, error)
• func ProtomapsOptionsFromURL(u *url.URL) (*protomaps.ProtomapsOptions, error)
• func ProviderURIFromFlagSet(fs *flag.FlagSet) (string, error)
• func RegisterProvider(ctx context.Context, scheme string, init_func ProviderInitializationFunc) error
• func Schemes() []string
• type LeafletProvider
  • func (p *LeafletProvider) AppendAssetHandlers(mux *http.ServeMux) error
  • func (p *LeafletProvider) AppendResourcesHandler(handler http.Handler) http.Handler
  • func (p *LeafletProvider) Scheme() string
• type NullProvider
  • func (p *NullProvider) AppendAssetHandlers(mux *http.ServeMux) error
  • func (p *NullProvider) AppendResourcesHandler(handler http.Handler) http.Handler
  • func (p *NullProvider) Scheme() string
• type ProtomapsProvider
  • func (p *ProtomapsProvider) AppendAssetHandlers(mux *http.ServeMux) error
  • func (p *ProtomapsProvider) AppendResourcesHandler(handler http.Handler) http.Handler
  • func (p *ProtomapsProvider) Scheme() string
• type Provider
  • func NewLeafletProvider(ctx context.Context, uri string) (Provider, error)
  • func NewNullProvider(ctx context.Context, uri string) (Provider, error)
  • func NewProtomapsProvider(ctx context.Context, uri string) (Provider, error)
  • func NewProvider(ctx context.Context, uri string) (Provider, error)
• type ProviderInitializationFunc

Constants

const JavaScriptAtEOFFlag string = "javascript-at-eof"

The names of the commandline flag or query parameter used to assign the `javascript_at_eof` variable.

const LEAFLET_SCHEME string = "leaflet"

const LeafletEnableDrawFlag string = "leaflet-enable-draw"

The name of the commandline flag or query parameter used to assign the `leaflet_enable_draw` variable.

const LeafletEnableFullscreenFlag string = "leaflet-enable-fullscreen"

The name of the commandline flag or query parameter used to assign the `leaflet_enable_fullscreen` variable.

const LeafletEnableHashFlag string = "leaflet-enable-hash"

The name of the commandline flag or query parameter used to assign the `leaflet_enable_hash` variable.

const LeafletTileURLFlag string = "leaflet-tile-url"

The name of the commandline flag or query parameter used to assign the `leaflet_tile_url` variable.

const MapPrefixFlag string = "map-prefix"

const MapProviderFlag string = "map-provider"

The name of the commandline flag or query parameter used to assign the `map_provider` variable.

const NULL_SCHEME string = "null"

const PROTOMAPS_SCHEME string = "protomaps"

const ProtomapsBucketURIFlag string = "protomaps-bucket-uri"

The name of the commandline flag or query parameter used to assign the `protomaps_bucket_uri` variable.

const ProtomapsCacheSizeFlag string = "protomaps-caches-size"

The name of the commandline flag or query parameter used to assign the `protomaps_cache_size` variable.

const ProtomapsDatabaseFlag string = "protomaps-database"

The name of the commandline flag or query parameter used to assign the `protomaps_database` variable.

const ProtomapsLabelRulesURIFlag string = "protomaps-label-rules-uri"

The names of the commandline flag or query parameter used to assign the `protomaps_paint_rules_uri` variable.

const ProtomapsPaintRulesURIFlag string = "protomaps-paint-rules-uri"

The names of the commandline flag or query parameter used to assign the `protomaps_paint_rules_uri` variable.

const ProtomapsServeTilesFlag string = "protomaps-serve-tiles"

The name of the commandline flag or query parameter used to assign the `protomaps_serve_tiles` variable.

const ProtomapsTileURLFlag string = "protomaps-tile-url"

The name of the commandline flag or query parameter used to assign the `protomaps_tile_url` variable.

const RollupAssetsFlag string = "rollup-assets"

The names of the commandline flag or query parameter used to assign the `rollup_assets` variable.

Functions

func AppendLeafletFlags

func AppendLeafletFlags(fs *flag.FlagSet) error

func AppendProtomapsProviderFlags

func AppendProtomapsProviderFlags(fs *flag.FlagSet) error

func AppendProviderFlags

func AppendProviderFlags(fs *flag.FlagSet) error

func LeafletOptionsFromURL

func LeafletOptionsFromURL(u *url.URL) (*leaflet.LeafletOptions, error)

func ProtomapsOptionsFromURL

func ProtomapsOptionsFromURL(u *url.URL) (*protomaps.ProtomapsOptions, error)

func ProviderURIFromFlagSet

func ProviderURIFromFlagSet(fs *flag.FlagSet) (string, error)

func RegisterProvider

func RegisterProvider(ctx context.Context, scheme string, init_func ProviderInitializationFunc) error

RegisterProvider registers 'scheme' as a key pointing to 'init_func' in an internal lookup table used to create new `Provider` instances by the `NewProvider` method.

func Schemes

func Schemes() []string

Schemes returns the list of schemes that have been registered.

Types

type LeafletProvider

type LeafletProvider struct {
	Provider
	// contains filtered or unexported fields
}

func (*LeafletProvider) AppendAssetHandlers

func (p *LeafletProvider) AppendAssetHandlers(mux *http.ServeMux) error

func (*LeafletProvider) AppendResourcesHandler

func (p *LeafletProvider) AppendResourcesHandler(handler http.Handler) http.Handler

func (*LeafletProvider) Scheme

func (p *LeafletProvider) Scheme() string

type NullProvider

type NullProvider struct {
	Provider
}

func (*NullProvider) AppendAssetHandlers

func (p *NullProvider) AppendAssetHandlers(mux *http.ServeMux) error

func (*NullProvider) AppendResourcesHandler

func (p *NullProvider) AppendResourcesHandler(handler http.Handler) http.Handler

func (*NullProvider) Scheme

func (p *NullProvider) Scheme() string

type ProtomapsProvider

type ProtomapsProvider struct {
	Provider
	// contains filtered or unexported fields
}

func (*ProtomapsProvider) AppendAssetHandlers

func (p *ProtomapsProvider) AppendAssetHandlers(mux *http.ServeMux) error

func (*ProtomapsProvider) AppendResourcesHandler

func (p *ProtomapsProvider) AppendResourcesHandler(handler http.Handler) http.Handler

func (*ProtomapsProvider) Scheme

func (p *ProtomapsProvider) Scheme() string

type Provider

type Provider interface {
	Scheme() string
	AppendResourcesHandler(handler http.Handler) http.Handler
	AppendAssetHandlers(mux *http.ServeMux) error
}

func NewLeafletProvider

func NewLeafletProvider(ctx context.Context, uri string) (Provider, error)

func NewNullProvider

func NewNullProvider(ctx context.Context, uri string) (Provider, error)

func NewProtomapsProvider

func NewProtomapsProvider(ctx context.Context, uri string) (Provider, error)

func NewProvider

func NewProvider(ctx context.Context, uri string) (Provider, error)

NewProvider returns a new `Provider` instance configured by 'uri'. The value of 'uri' is parsed as a `url.URL` and its scheme is used as the key for a corresponding `ProviderInitializationFunc` function used to instantiate the new `Provider`. It is assumed that the scheme (and initialization function) have been registered by the `RegisterProvider` method.

type ProviderInitializationFunc

type ProviderInitializationFunc func(ctx context.Context, uri string) (Provider, error)

ProviderInitializationFunc is a function defined by individual provider package and used to create an instance of that provider