postcode

package module

Go to main page

Versions in this module

v0

v0.2.6

Nov 5, 2026

v0.2.5

Oct 23, 2026

Changes in this version

type AgentDispatcher — js/wasm

+ func (d *AgentDispatcher) DispatchJSValue(ctx context.Context, name string, argsObj js.Value) (any, error)

type LGARecord

+ func NearestLGA(lat, lng float64) (LGARecord, float64, bool)

v0.2.4

Oct 21, 2026

Changes in this version

+ var ErrTemporaryCode = errors.New(...)

+ func FormatTemporary(raw string) string

+ func IsTemporary(raw string) bool

+ func IsTemporaryCode(raw string) bool

type DiagnosticReport

+ IsTemporary bool

type LookupResponse

+ Temporary bool

type NearbyUnit

+ LocalityName string

v0.2.3

Oct 17, 2026

Changes in this version

+ func QRPNG(raw string, opts ...QROptions) ([]byte, error)

+ func QRSVG(raw string, opts ...QROptions) (string, error)

+ func QRTerminal(raw string, opts ...QROptions) (string, error)

type Client

+ func (c *Client) GenerateQR(ctx context.Context, code string, opts ...QROptions) (*QRCode, error)

type Location

+ func (l Location) GeoURI() string

+ func (l Location) QR(opts ...QROptions) (*QRCode, error)

type Postcode

+ func (p Postcode) AreaPrefix() string

+ func (p Postcode) Masked() string

+ func (p Postcode) QR(opts ...QROptions) (*QRCode, error)

+ func (p Postcode) QRPNG(opts ...QROptions) ([]byte, error)

+ func (p Postcode) QRSVG(opts ...QROptions) (string, error)

+ func (p Postcode) QRTerminal(opts ...QROptions) (string, error)

+ type QRCode struct

+ Address string

+ BackgroundColor string

+ Compact string

+ Dimension int

+ ForegroundColor string

+ GoogleMapsURL string

+ IncludeLabel bool

+ InvertASCII bool

+ LGACode string

+ LGAName string

+ Latitude float64

+ Level QRErrorCorrectionLevel

+ Longitude float64

+ Modules [][]bool

+ Payload string

+ PayloadType QRPayloadType

+ Postcode string

+ QuietZone int

+ Size int

+ Spaced string

+ StateCode string

+ StateName string

+ Subtitle string

+ Title string

+ Version int

+ Zone string

+ func GenerateQR(raw string, opts ...QROptions) (*QRCode, error)

+ func (q *QRCode) ASCII() string

+ func (q *QRCode) DataURI() (string, error)

+ func (q *QRCode) Image() image.Image

+ func (q *QRCode) LabelSVG() string

+ func (q *QRCode) MatrixSVG() string

+ func (q *QRCode) PNG() ([]byte, error)

+ func (q *QRCode) PrintableHTML() string

+ func (q *QRCode) SVG() string

+ func (q *QRCode) SVGDataURI() string

+ func (q *QRCode) SaveHTML(filename string) error

+ func (q *QRCode) SavePNG(filename string) error

+ func (q *QRCode) SaveSVG(filename string) error

+ func (q *QRCode) Terminal() string

+ func (q *QRCode) WritePNG(w io.Writer) error

+ func (q *QRCode) WriteSVG(w io.Writer) error

+ type QRErrorCorrectionLevel string

+ const QRLevelH

+ const QRLevelL

+ const QRLevelM

+ const QRLevelQ

+ type QROptions struct

+ BackgroundColor string

+ ForegroundColor string

+ IncludeLabel bool

+ InvertASCII bool

+ Level QRErrorCorrectionLevel

+ Payload QRPayloadType

+ QuietZone int

+ Size int

+ Subtitle string

+ Title string

+ type QRPayloadType string

+ const QRPayloadAppleMaps

+ const QRPayloadCompact

+ const QRPayloadDirections

+ const QRPayloadGeoURI

+ const QRPayloadGoogleMaps

+ const QRPayloadJSON

+ const QRPayloadOSM

+ const QRPayloadPostcode

+ const QRPayloadSpaced

+ const QRPayloadText

+ type RedactedAddress struct

+ AreaPrefix string

+ LGACode string

+ MaskedPostcode string

+ MaskedPostcodes []string

+ NDPACompliant bool

+ PIIRedactedCount int

+ RedactedText string

+ RedactedTypes []string

+ StateCode string

+ func RedactPII(raw string) RedactedAddress

v0.2.2

Oct 17, 2026

Changes in this version

+ func DistanceMeters(codeA, codeB string) (float64, error)

+ func LookupLegacyPrefix(sixDigit string) (prefix string, label string, ok bool)

+ func NewHandlerTransport(h http.Handler) http.RoundTripper

+ type AddressExtraction struct

+ Confidence string

+ LGACode string

+ LGAName string

+ Landmark string

+ Latitude float64

+ LegacyPostcode string

+ Locality string

+ Longitude float64

+ Postcode string

+ PostcodeValid bool

+ Raw string

+ StateCode string

+ StateName string

+ Street string

+ SuggestedPrefix string

+ func ExtractAddress(raw string) AddressExtraction

type ClientOption

+ func WithHandler(h http.Handler) ClientOption

type DiagnosticReport

+ SuggestedFix string

type LGARecord

+ func LookupLGA(state, query string) (LGARecord, bool)

type Location

+ func (l Location) DistanceTo(other Location) float64

+ func (l Location) PointGeometry() PointGeometry

type Postcode

+ func MustParse(raw string) Postcode

+ func Repair(raw string) (Postcode, error)

+ func TryRepair(raw string) (Postcode, bool)

+ func (p *Postcode) Scan(src any) error

+ func (p Postcode) AppendFormatted(b []byte) []byte

+ func (p Postcode) Compare(other Postcode) int

+ func (p Postcode) DistanceTo(other Postcode) float64

+ func (p Postcode) Equal(other Postcode) bool

+ func (p Postcode) Slug() string

+ func (p Postcode) Value() (driver.Value, error)

type RateLimitInfo

+ CreditBalance int

type StateRecord

+ func LookupState(query string) (StateRecord, bool)

v0.2.1

Oct 8, 2026

v0.2.0

Oct 8, 2026

Changes in this version

type Postcode

+ func (p Postcode) Disassemble() Segments

+ func (p Postcode) Segments() Segments

v0.1.9

Oct 7, 2026

Changes in this version

+ func ClearDiskCache() error

+ func DefaultCachePath() string

+ func ExportBuildingsJSON(w io.Writer) error

+ func GetCachePath() string

+ func GetCacheStats() (int, string)

+ func IsValid(raw string) bool

+ func LoadBuildingsCSV(r io.Reader) (int, error)

+ func LoadBuildingsJSON(r io.Reader) (int, error)

+ func LoadDiskCache() error

+ func SaveDiskCache() error

+ func SetCachePath(path string) error

+ func Validate(raw string) error

type AssembledPostcode

+ func AssembleSegments(segs Segments) (AssembledPostcode, error)

type BuildingRecord

+ func AllBuildingRecords() []BuildingRecord

+ type ChainGeocoder struct

+ Geocoders []Geocoder

+ func NewChainGeocoder(geocoders ...Geocoder) *ChainGeocoder

+ func (c *ChainGeocoder) Geocode(ctx context.Context, query string) (float64, float64, error)

type Client

+ func (c *Client) Health(ctx context.Context) error

+ func (c *Client) NearbyPostcode(ctx context.Context, code string, radiusM float64) (*NearbyResponse, error)

+ func (c *Client) ReferenceAreas(ctx context.Context, state, lga, district string) ([]NamedCode, error)

+ func (c *Client) ReferenceDistricts(ctx context.Context, state, lga string) ([]NamedCode, error)

+ func (c *Client) ReferenceLGAs(ctx context.Context, state string) ([]NamedCode, error)

+ func (c *Client) ReferenceStates(ctx context.Context) ([]NamedCode, error)

+ func (c *Client) ReverseCoordinates(ctx context.Context, lat, lng, maxDistanceM float64) (*ReverseResponse, error)

type ClientOption

+ func WithGeocoder(g Geocoder) ClientOption

+ func WithGoogleMapsKey(key string) ClientOption

+ type Geocoder interface

+ Geocode func(ctx context.Context, query string) (lat, lng float64, err error)

+ func DefaultGeocoder(googleMapsKey string, httpClient *http.Client) Geocoder

+ type GoogleMapsGeocoder struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ func NewGoogleMapsGeocoder(apiKey string, client *http.Client) *GoogleMapsGeocoder

+ func (g *GoogleMapsGeocoder) Geocode(ctx context.Context, query string) (float64, float64, error)

+ type NamedCode struct

+ Code string

+ Name string

+ func StateLGAs(state string) []NamedCode

type NearbyParams

+ Postcode string

type NearbyResponse

+ func (r *NearbyResponse) UnmarshalJSON(data []byte) error

type NearbyUnit

+ func SearchNearbyBuildingsOffline(lat, lng, radiusM float64) []NearbyUnit

+ type NominatimGeocoder struct

+ BaseURL string

+ HTTPClient *http.Client

+ UserAgent string

+ func NewNominatimGeocoder(userAgent string, client *http.Client) *NominatimGeocoder

+ func (n *NominatimGeocoder) Geocode(ctx context.Context, query string) (float64, float64, error)

type ReverseResponse

+ func ReverseCoordinatesOffline(lat, lng, maxDistanceM float64) *ReverseResponse

type Segments

+ func NormalizeSegments(segs Segments) Segments

v0.1.8

Oct 5, 2026

v0.1.7

Oct 4, 2026

v0.1.6

Oct 4, 2026

v0.1.5

Oct 4, 2026

v0.1.4

Oct 4, 2026

Changes in this version

+ const MCPProtocolVersion2025

+ const MCPProtocolVersionLatest

+ const MCPProtocolVersionLegacy

+ const MCPServerName

+ const MCPServerVersion

+ var ErrAgentBudgetExceeded = errors.New("postcode: agent call budget exceeded for session")

+ var MCPSupportedVersions = []string

+ func BaselineExtract(raw string) (extractedState string, extractedPostcode string)

+ type AgentDispatcher struct

+ func NewAgentDispatcher(client *Client) *AgentDispatcher

+ func (d *AgentDispatcher) Dispatch(ctx context.Context, name string, argsJSON []byte) (any, error)

+ func (d *AgentDispatcher) DispatchString(ctx context.Context, name string, argsJSON []byte) (string, error)

+ func (d *AgentDispatcher) Tools() []ToolDef

+ type AgentGuardConfig struct

+ AutoDowngradeToLevel1 bool

+ AutoFallbackToOffline bool

+ MaxCommercialCallsPerRun int

+ MaxTotalCallsPerRun int

+ type AgentGuardMetrics struct

+ CommercialCalls int64

+ DowngradedCalls int64

+ OfflineFallbacks int64

+ TotalCalls int64

+ type Cache interface

+ Clear func()

+ Delete func(key string)

+ Get func(key string) (any, bool)

+ Len func() int

+ Set func(key string, val any, ttl time.Duration)

type Client

+ func (c *Client) AgentMetrics() AgentGuardMetrics

type ClientOption

+ func WithAgentGuard(cfg AgentGuardConfig) ClientOption

+ func WithCache(cache Cache) ClientOption

+ func WithDefaultCache() ClientOption

+ type DiagnosticReport struct

+ ActionableTip string

+ CleanLength int

+ Diagnoses []SegmentDiagnosis

+ FormatScore float64

+ Input string

+ Normalized string

+ Valid bool

+ func Diagnose(raw string) DiagnosticReport

+ type EvalResult struct

+ AvgFormatScore float64

+ DurationMs int64

+ PostcodeAccuracy float64

+ StateAccuracy float64

+ TotalSamples int

+ ValidRate float64

+ func EvaluateAgent(dataset []SyntheticAddress, extractor func(raw string) (string, string)) EvalResult

+ type GeneratorOptions struct

+ Count int

+ NoiseRate float64

+ Seed uint64

+ type MCPOption func(*MCPServer)

+ func WithMCPLogger(logger *log.Logger) MCPOption

+ type MCPServer struct

+ func NewMCPServer(client *Client, opts ...MCPOption) *MCPServer

+ func (s *MCPServer) Serve(in io.Reader, out io.Writer) error

+ type MemoryCache struct

+ func NewMemoryCache(maxEntries int, defaultTTL time.Duration) *MemoryCache

+ func (c *MemoryCache) Clear()

+ func (c *MemoryCache) Delete(key string)

+ func (c *MemoryCache) Get(key string) (any, bool)

+ func (c *MemoryCache) Len() int

+ func (c *MemoryCache) Set(key string, val any, ttl time.Duration)

type Postcode

+ func (p Postcode) Compact() string

+ type SegmentDiagnosis struct

+ Expected string

+ Input string

+ Message string

+ Segment string

+ Suggestions []string

+ type SyntheticAddress struct

+ ExpectedLGA string

+ ExpectedLat float64

+ ExpectedLng float64

+ ExpectedPostcode string

+ ExpectedState string

+ ExpectedStateCode string

+ NoiseType string

+ RawText string

+ func GenerateSyntheticDataset(opts GeneratorOptions) []SyntheticAddress

+ type ToolDef struct

+ Description string

+ Name string

+ Parameters map[string]any

+ func DefaultAgentTools() []ToolDef

+ func (t ToolDef) AnthropicTool() map[string]any

+ func (t ToolDef) GeminiFunctionDeclaration() map[string]any

+ func (t ToolDef) OpenAITool() map[string]any

+ type ValidationError struct

+ Report DiagnosticReport

+ func (e *ValidationError) Error() string

v0.1.3

Oct 4, 2026

v0.1.2

Oct 4, 2026

v0.1.1

Oct 3, 2026

Changes in this version

+ var ErrUnknownState = errors.New("postcode: unknown nigerian state code")

+ var NigerianStates = map[string]StateRecord

+ func Coordinates(raw string) (lat, lng float64, err error)

+ func GoogleMapsURL(raw string) (string, error)

+ func RegisterKnownBuilding(rec BuildingRecord)

+ type BuildingRecord struct

+ Address string

+ LGACode string

+ LGAName string

+ Latitude float64

+ Longitude float64

+ Postcode string

+ StateCode string

+ StateName string

+ Zone string

type Client

+ func (c *Client) ResolveLocation(ctx context.Context, code string) (*Location, error)

+ type LGARecord struct

+ LGACode string

+ Latitude float64

+ Longitude float64

+ Name string

+ StateCode string

+ type Location struct

+ Address string

+ Compact string

+ LGACode string

+ LGAName string

+ Latitude float64

+ Longitude float64

+ Postcode string

+ Precision Precision

+ StateCode string

+ StateName string

+ Zone string

+ func ResolveLocation(raw string) (Location, error)

+ func (l Location) AppleMapsURL() string

+ func (l Location) Coordinates() (lat, lng float64)

+ func (l Location) GoogleMapsDirectionsURL() string

+ func (l Location) GoogleMapsURL() string

+ func (l Location) IsZero() bool

+ func (l Location) OpenStreetMapURL() string

+ func (l Location) SearchQuery() string

type LookupLevel

+ const LevelMax

type Postcode

+ func (p Postcode) Coordinates() (lat, lng float64)

+ func (p Postcode) GoogleMapsURL() string

+ func (p Postcode) Location() Location

+ type Precision uint8

+ const PrecisionArea

+ const PrecisionBuilding

+ const PrecisionDistrict

+ const PrecisionLGA

+ const PrecisionState

+ func (p *Precision) UnmarshalJSON(data []byte) error

+ func (p *Precision) UnmarshalText(text []byte) error

+ func (p Precision) MarshalJSON() ([]byte, error)

+ func (p Precision) MarshalText() ([]byte, error)

+ func (p Precision) String() string

+ type StateRecord struct

+ Capital string

+ Code string

+ Latitude float64

+ Longitude float64

+ Name string

+ Zone string

v0.1.0

Oct 2, 2026

Changes in this version

+ const DefaultBaseURL

+ var ErrInvalidFormat = errors.New("postcode: invalid format structure")

+ var ErrInvalidLength = errors.New("postcode: invalid length, must be exactly 11 alphanumeric characters")

+ func BatchParseSeq(inputs []string) iter.Seq2[int, Result[Postcode]]

+ func ParseSeq(inputs []string) iter.Seq2[Postcode, error]

+ type APIError struct

+ Code string

+ Message string

+ RateLimit *RateLimitInfo

+ RetryAfter time.Duration

+ StatusCode int

+ func (e *APIError) Error() string

+ func (e *APIError) IsInsufficientCredits() bool

+ func (e *APIError) IsNotFound() bool

+ func (e *APIError) IsRateLimit() bool

+ func (e *APIError) IsUnauthorized() bool

+ func (e *APIError) UnmarshalJSON(data []byte) error

+ type AdministrativeAddress struct

+ Area string

+ AreaName string

+ District string

+ DistrictName string

+ LGA string

+ LGAName string

+ LocalityName string

+ State string

+ StateName string

+ Unit string

+ Zone string

+ type AssembledPostcode struct

+ Compact string

+ Display string

+ Postcode string

+ type AutocompleteResponse struct

+ Segment string

+ Suggestions []AutocompleteSuggestion

+ type AutocompleteSuggestion struct

+ Code string

+ Label string

+ type Client struct

+ func NewClient(opts ...ClientOption) (*Client, error)

+ func (c *Client) Assemble(ctx context.Context, segs Segments) (*AssembledPostcode, error)

+ func (c *Client) Autocomplete(ctx context.Context, query string) (*AutocompleteResponse, error)

+ func (c *Client) Disassemble(ctx context.Context, code string) (*Segments, error)

+ func (c *Client) Lookup(ctx context.Context, code string, level LookupLevel) (*LookupResponse, error)

+ func (c *Client) Nearby(ctx context.Context, params NearbyParams) (*NearbyResponse, error)

+ func (c *Client) RateLimit() *RateLimitInfo

+ func (c *Client) Reverse(ctx context.Context, params ReverseParams) (*ReverseResponse, error)

+ type ClientOption func(*Client)

+ func WithAPIKey(key string) ClientOption

+ func WithBaseTransport(rt http.RoundTripper) ClientOption

+ func WithBaseURL(customURL string) ClientOption

+ func WithRateLimitRetry(enabled bool, maxDelay time.Duration) ClientOption

+ func WithRetryConfig(cfg RetryConfig) ClientOption

+ func WithTelemetry(t Telemetry) ClientOption

+ func WithTimeout(d time.Duration) ClientOption

+ func WithTransport(rt http.RoundTripper) ClientOption

+ type LookupLevel int

+ const Level1

+ const Level2

+ const Level3

+ const Level4

+ const Level5

+ const LevelDefault

+ type LookupResponse struct

+ AdministrativeAddress *AdministrativeAddress

+ BuildingUseStatus string

+ OtherBuildingInfo map[string]any

+ PointGeometry *PointGeometry

+ Postcode string

+ RecentHouseAddress *RecentHouseAddress

+ Valid bool

+ type MetricsRecorder interface

+ AddInflight func(ctx context.Context, delta int64)

+ RecordDuration func(ctx context.Context, method, endpoint string, statusCode int, ...)

+ type NearbyParams struct

+ Latitude float64

+ Longitude float64

+ RadiusM float64

+ type NearbyResponse struct

+ Results []NearbyUnit

+ type NearbyUnit struct

+ Address string

+ Confidence string

+ Display string

+ DistanceM float64

+ LGAName string

+ Postcode string

+ StateName string

+ type PointGeometry struct

+ Coordinates []float64

+ Type string

+ type Postcode struct

+ func Parse(raw string) (Postcode, error)

+ func (p *Postcode) UnmarshalText(text []byte) error

+ func (p Postcode) AppendText(b []byte) ([]byte, error)

+ func (p Postcode) Area() string

+ func (p Postcode) BuildingUnit() string

+ func (p Postcode) District() string

+ func (p Postcode) Formatted() string

+ func (p Postcode) IsZero() bool

+ func (p Postcode) LGA() string

+ func (p Postcode) MarshalText() ([]byte, error)

+ func (p Postcode) Raw() string

+ func (p Postcode) State() string

+ func (p Postcode) String() string

+ type RateLimitInfo struct

+ Limit int

+ Remaining int

+ ResetAt time.Time

+ RetryAfter time.Duration

+ func ParseRateLimitInfo(h http.Header) *RateLimitInfo

+ type RecentHouseAddress struct

+ Address string

+ HouseNumber string

+ LocalityName string

+ Recent string

+ StreetName string

+ type Result struct

+ Err error

+ Value T

+ type RetryConfig struct

+ BaseDelay time.Duration

+ DisableRateLimit bool

+ MaxDelay time.Duration

+ MaxRateLimitDelay time.Duration

+ MaxRetries int

+ type RetryTransport struct

+ Base http.RoundTripper

+ Config RetryConfig

+ func NewRetryTransport(base http.RoundTripper, cfg RetryConfig) *RetryTransport

+ func (r *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type ReverseParams struct

+ Latitude float64

+ Longitude float64

+ MaxDistanceM float64

+ type ReverseResponse struct

+ Area string

+ Coordinate []float64

+ District string

+ Found bool

+ Message string

+ RadiusM float64

+ State string

+ Unit *NearbyUnit

+ type Segments struct

+ Area string

+ District string

+ LGA string

+ State string

+ Unit string

+ type Span interface

+ End func()

+ RecordError func(err error)

+ SetAttribute func(key, value string)

+ SetStatus func(code int, msg string)

+ type Telemetry struct

+ Metrics MetricsRecorder

+ Tracer Tracer

+ func NopTelemetry() Telemetry

+ type Tracer interface

+ Start func(ctx context.Context, operation string) (context.Context, Span)

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