Safe Haskell	None
Language	Haskell2010

Country

Contents

Three digit code
Name
Alpha-2 and Alpha-3

Synopsis

data Country
encodeNumeric :: Country -> Word16
decodeNumeric :: Word16 -> Maybe Country
encodeEnglish :: Country -> Text
decode :: Text -> Maybe Country
decodeUtf8 :: ByteString -> Maybe Country
parser :: Parser Country
parserUtf8 :: Parser Country
alphaTwoUpper :: Country -> Text
alphaThreeUpper :: Country -> Text
alphaThreeLower :: Country -> Text
alphaTwoLower :: Country -> Text
decodeAlphaTwo :: Text -> Maybe Country
decodeAlphaThree :: Text -> Maybe Country

Documentation

data Country #

A country recognized by ISO 3166.

Instances

Bounded Country #
Instance details Defined in Country.Unexposed.Names Methods minBound :: Country # maxBound :: Country #
Enum Country #
Instance details Defined in Country.Unexposed.Names Methods succ :: Country -> Country # pred :: Country -> Country # toEnum :: Int -> Country # fromEnum :: Country -> Int # enumFrom :: Country -> [Country] # enumFromThen :: Country -> Country -> [Country] # enumFromTo :: Country -> Country -> [Country] # enumFromThenTo :: Country -> Country -> Country -> [Country] #
Eq Country #
Instance details Defined in Country.Unexposed.Names Methods (==) :: Country -> Country -> Bool # (/=) :: Country -> Country -> Bool #
Ord Country #
Instance details Defined in Country.Unexposed.Names Methods compare :: Country -> Country -> Ordering # (<) :: Country -> Country -> Bool # (<=) :: Country -> Country -> Bool # (>) :: Country -> Country -> Bool # (>=) :: Country -> Country -> Bool # max :: Country -> Country -> Country # min :: Country -> Country -> Country #
Show Country #
Instance details Defined in Country.Unexposed.Names Methods showsPrec :: Int -> Country -> ShowS # show :: Country -> String # showList :: [Country] -> ShowS #
Generic Country #
Instance details Defined in Country.Unexposed.Names Associated Types type Rep Country :: * -> * # Methods from :: Country -> Rep Country x # to :: Rep Country x -> Country #
Hashable Country #
Instance details Defined in Country.Unexposed.Names Methods hashWithSalt :: Int -> Country -> Int # hash :: Country -> Int #
ToJSON Country #
Instance details Defined in Country.Unexposed.Names Methods toJSON :: Country -> Value # toEncoding :: Country -> Encoding # toJSONList :: [Country] -> Value # toEncodingList :: [Country] -> Encoding #
FromJSON Country #
Instance details Defined in Country.Unexposed.Names Methods parseJSON :: Value -> Parser Country # parseJSONList :: Value -> Parser [Country] #
Storable Country #
Instance details Defined in Country.Unexposed.Names Methods sizeOf :: Country -> Int # alignment :: Country -> Int # peekElemOff :: Ptr Country -> Int -> IO Country # pokeElemOff :: Ptr Country -> Int -> Country -> IO () # peekByteOff :: Ptr b -> Int -> IO Country # pokeByteOff :: Ptr b -> Int -> Country -> IO () # peek :: Ptr Country -> IO Country # poke :: Ptr Country -> Country -> IO () #
NFData Country #
Instance details Defined in Country.Unexposed.Names Methods rnf :: Country -> () #
Prim Country #
Instance details Defined in Country.Unexposed.Names Methods sizeOf# :: Country -> Int# # alignment# :: Country -> Int# # indexByteArray# :: ByteArray# -> Int# -> Country # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Country#) # writeByteArray# :: MutableByteArray# s -> Int# -> Country -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Country -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> Country # readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, Country#) # writeOffAddr# :: Addr# -> Int# -> Country -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> Country -> State# s -> State# s #
type Rep Country #
Instance details Defined in Country.Unexposed.Names type Rep Country = D1 (MetaData "Country" "Country.Unexposed.Names" "country-0.1.6-EUQbRoAcDriFDDpYhefKWN" True) (C1 (MetaCons "Country" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word16)))

Three digit code

encodeNumeric :: Country -> Word16 #

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

decodeNumeric :: Word16 -> Maybe Country #

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 #

The name of a country given in English

decode :: Text -> Maybe Country #

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.

decodeUtf8 :: ByteString -> Maybe Country #

parser :: Parser Country #

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.

parserUtf8 :: Parser Country #

Alpha-2 and Alpha-3

alphaTwoUpper :: Country -> Text #

The alpha-2 country code, uppercase

alphaThreeUpper :: Country -> Text #

The alpha-3 country code, uppercase

alphaThreeLower :: Country -> Text #

The alpha-3 country code, lowercase

alphaTwoLower :: Country -> Text #

The alpha-2 country code, lowercase

decodeAlphaTwo :: Text -> Maybe Country #

decodeAlphaThree :: Text -> Maybe Country #