address

Sep 25, 2020

Changes in this version

type Address

+ func (a Address) IsZero() bool

Sep 10, 2018

Changes in this version

+ var ErrInvalidAdministrativeArea = errors.New("invalid administrative area")

+ var ErrInvalidCountryCode = errors.New("invalid country code")

+ var ErrInvalidDependentLocality = errors.New("invalid dependent locality")

+ var ErrInvalidLocality = errors.New("invalid locality")

+ var ErrInvalidPostCode = errors.New("invalid post code")

+ func Validate(address Address) error

+ func WithAdministrativeArea(administrativeArea string) func(*Address)

+ func WithCountry(countryCode string) func(*Address)

+ func WithDependentLocality(dependentLocality string) func(*Address)

+ func WithLocality(locality string) func(*Address)

+ func WithName(name string) func(*Address)

+ func WithOrganization(organization string) func(*Address)

+ func WithPostCode(postCode string) func(*Address)

+ func WithSortingCode(sortingCode string) func(*Address)

+ func WithStreetAddress(streetAddress []string) func(*Address)

+ type Address struct

+ AdministrativeArea string

+ Country string

+ DependentLocality string

+ Locality string

+ Name string

+ Organization string

+ PostCode string

+ SortingCode string

+ StreetAddress []string

+ func New(fields ...func(*Address)) Address

+ func NewValid(fields ...func(*Address)) (Address, error)

+ type AdministrativeAreaData struct

+ ID string

+ Localities []LocalityData

+ Name string

+ type CountryData struct

+ AdministrativeAreaNameType FieldName

+ AdministrativeAreas map[string][]AdministrativeAreaData

+ Allowed []Field

+ DefaultLanguage string

+ DependentLocalityNameType FieldName

+ Format string

+ LatinizedFormat string

+ LocalityNameType FieldName

+ PostCodeNameType FieldName

+ PostCodeRegex PostCodeRegexData

+ Required []Field

+ func GetCountry(countryCode string) CountryData

+ type CountryList []CountryListItem

+ func (c CountryList) Bytes(i int) []byte

+ func (c CountryList) Len() int

+ func (c CountryList) Swap(i, j int)

+ type CountryListItem struct

+ Code string

+ Name string

+ func ListCountries(language string) []CountryListItem

+ type DefaultFormatter struct

+ Latinize bool

+ Output Outputter

+ func (d DefaultFormatter) Format(address Address, language string) string

+ type DependentLocalityData struct

+ ID string

+ Name string

+ type ErrMissingRequiredFields struct

+ Fields []Field

+ func (e ErrMissingRequiredFields) Error() string

+ type ErrUnsupportedFields struct

+ Fields []Field

+ func (e ErrUnsupportedFields) Error() string

+ type ExactMatcher struct

+ Matches []string

+ Ranges []PostCodeRange

+ func (m ExactMatcher) Match(postCode string) bool

+ type Field int

+ const AdministrativeArea

+ const Country

+ const DependentLocality

+ const Locality

+ const Name

+ const Organization

+ const PostCode

+ const SortingCode

+ const StreetAddress

+ func (i Field) Key() string

+ func (i Field) String() string

+ type FieldName int

+ const Area

+ const City

+ const County

+ const Department

+ const District

+ const DoSi

+ const Eircode

+ const Emirate

+ const Island

+ const Neighborhood

+ const Oblast

+ const PINCode

+ const Parish

+ const PostTown

+ const PostalCode

+ const Prefecture

+ const Province

+ const State

+ const Suburb

+ const Townland

+ const VillageTownship

+ const ZipCode

+ func (i FieldName) String() string

+ type HTMLOutputter struct

+ func (h HTMLOutputter) TransformFormat(format string, upper map[Field]struct{}) string

+ type LocalityData struct

+ DependentLocalities []DependentLocalityData

+ ID string

+ Name string

+ type Outputter interface

+ TransformFormat func(format string, upper map[Field]struct{}) string

+ type PostCodeMatcher interface

+ Match func(postcode string) bool

+ type PostCodeRange struct

+ End int

+ Start int

+ type PostCodeRegexData struct

+ Regex string

+ SubdivisionRegex map[string]PostCodeRegexData

+ type PostalLabelFormatter struct

+ Latinize bool

+ OriginCountryCode string

+ Output Outputter

+ func (f PostalLabelFormatter) Format(address Address, language string) string

+ type RegexMatcher struct

+ Regex *regexp.Regexp

+ func (m RegexMatcher) Match(postCode string) bool

+ type StringOutputter struct

+ func (s StringOutputter) TransformFormat(format string, upper map[Field]struct{}) string

+ type Territory struct

+ AdministrativeArea string

+ Country string

+ DependentLocality string

+ ExcludedPostCodes PostCodeMatcher

+ IncludedPostCodes PostCodeMatcher

+ Locality string

+ type Zone []Territory

+ func (z Zone) Contains(address Address) bool