country-0.1.4: Country data type and functions

Safe HaskellNone
LanguageHaskell2010

Country

Contents

Synopsis

Documentation

data Country Source #

A country recognized by ISO 3166.

Instances

Bounded Country Source # 
Enum Country Source # 
Eq Country Source # 

Methods

(==) :: Country -> Country -> Bool #

(/=) :: Country -> Country -> Bool #

Ord Country Source # 
Show Country Source # 
Hashable Country Source # 

Methods

hashWithSalt :: Int -> Country -> Int #

hash :: Country -> Int #

FromJSON Country Source # 
ToJSON Country Source # 
Storable Country Source # 
Prim Country Source # 

Three digit code

encodeNumeric :: Country -> Word16 Source #

Convert a country to its numeric code. This is a three-digit number and will consequently be less than 1000.

decodeNumeric :: Word16 -> Maybe Country Source #

Get a country from a numeric code. Any code greater than 999 will not have a country associated with it. Additionally, many codes are unassigned.

Name

encodeEnglish :: Country -> Text Source #

The name of a country given in English

decode :: Text -> Maybe Country Source #

Parse a country from its name. This function is language-agnostic and is very generous with what it accepts. It handles official names, colloquial names, acroynms, and obsolete names for many countries. It strives to handle any source language. Open an issue on the issue tracker if their are names that are missing.

parser :: Parser Country Source #

Parse a country from its name using an attoparsec text parser. This function is language-agnostic and can handle any source language. In the case that one possible country name is a prefix of another possible name (for example, United States vs United States of America), the longest possible will be parsed.

Alpha-2 and Alpha-3

alphaTwoUpper :: Country -> Text Source #

The alpha-2 country code, uppercase

alphaThreeUpper :: Country -> Text Source #

The alpha-3 country code, uppercase

alphaThreeLower :: Country -> Text Source #

The alpha-3 country code, lowercase

alphaTwoLower :: Country -> Text Source #

The alpha-2 country code, lowercase