location

Documentation

Index

• Variables
• type Config
• type Location
  • func New(db *ip2location.DB, query *gountries.Query, tree *rtree.Generic[*orb.Node]) *Location
  • func (l *Location) GetByIP(ctx context.Context, ipa string) (string, string, error)
  • func (l *Location) GetByLatLng(ctx context.Context, lat, lng float64) (string, string, error)

Variables

var (
	// ErrInvalid for location.
	ErrInvalid = errors.New("invalid")

	// ErrNotFound for location.
	ErrNotFound = errors.New("not found")
)

var (
	// Module for fx.
	Module = fx.Options(
		fx.Provide(ip.NewDB),
		fx.Provide(country.NewQuery),
		fx.Provide(New),
		fx.Provide(orb.NewRTree),
	)
)

Types

type Config

type Config struct {
	Continent continent.Config `yaml:"continent"`
	IP        ip.Config        `yaml:"ip"`
}

Config for location.

type Location

type Location struct {
	// contains filtered or unexported fields
}

Location will find the country and continent by different criteria.

func New

func New(db *ip2location.DB, query *gountries.Query, tree *rtree.Generic[*orb.Node]) *Location

New location.

func (*Location) GetByIP

func (l *Location) GetByIP(ctx context.Context, ipa string) (string, string, error)

GetByIP a country and continent, otherwise error.

func (*Location) GetByLatLng

func (l *Location) GetByLatLng(ctx context.Context, lat, lng float64) (string, string, error)

GetByLatLng a country and continent, otherwise error.