ip2region

Documentation

Index

• Constants
• Variables
• type Reader
  • func NewReader(file string) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) Find(ip net.IP) (*model.IPInfo, error)
  • func (r *Reader) Meta() *model.Meta
  • func (r *Reader) SetOption(option interface{}) error

Constants

const (
	// FieldCountry 国家
	FieldCountry = "country"

	// FieldRegion 区域
	// 例如 华东/华北 等，在v2中基本为空
	FieldRegion = "region"

	// FieldProvince 省份
	FieldProvince = "province"

	// FieldCity 城市
	FieldCity = "city"

	// FieldISP 运营商
	FieldISP = "isp"
)

const (
	DBFormat = "ip2region"
	DBExt    = ".xdb"
)

Variables

var CommonFieldsAlias = map[string]string{
	model.Country:  FieldCountry,
	model.Province: FieldProvince,
	model.City:     FieldCity,
	model.ISP:      FieldISP,
}

CommonFieldsAlias 公共字段映射

var FullFields = []string{
	FieldCountry,
	FieldRegion,
	FieldProvince,
	FieldCity,
	FieldISP,
}

FullFields 全字段列表

Types

type Reader

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

Reader is a structure that provides functionalities to read from IP2Region IP database.

func NewReader

func NewReader(file string) (*Reader, error)

NewReader initializes a new instance of Reader.

func (*Reader) Close

func (r *Reader) Close() error

Close closes the IP database.

func (*Reader) Find

func (r *Reader) Find(ip net.IP) (*model.IPInfo, error)

Find retrieves IP information based on the given IP address.

func (*Reader) Meta

func (r *Reader) Meta() *model.Meta

Meta returns the meta-information of the IP database.

func (*Reader) SetOption

func (r *Reader) SetOption(option interface{}) error

SetOption configures the Reader with the provided option.