Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Country type and helpers.
Synopsis
- data Country
- encodeNumeric :: Country -> Word16
- decodeNumeric :: Word16 -> Maybe Country
- encodeEnglish :: Country -> Text
- encodeEnglishShort :: Country -> ShortText
- decode :: Text -> Maybe Country
- decodeUtf8 :: ByteString -> Maybe Country
- decodeUtf8Bytes :: Bytes -> Maybe Country
- parser :: Parser Country
- parserUtf8 :: Parser Country
- alphaTwoUpper :: Country -> Text
- alphaTwoUpperUtf8Ptr :: Country -> Ptr Word8
- alphaTwoUpperUtf8BoundedBuilder :: Country -> Builder 2
- alphaThreeUpper :: Country -> Text
- alphaThreeLower :: Country -> Text
- alphaTwoLower :: Country -> Text
- decodeAlphaTwo :: Text -> Maybe Country
- decodeAlphaThree :: Text -> Maybe Country
- hashMapUtf8 :: Map
- hashMapUtf16 :: Map
Documentation
A country recognized by ISO 3166.
Instances
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
encodeEnglishShort :: Country -> ShortText 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 there are names that are missing.
decodeUtf8 :: ByteString -> Maybe Country Source #
Decode a Country
from a UTF-8-encoded ByteString
.
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
alphaTwoUpperUtf8Ptr :: Country -> Ptr Word8 Source #
The alpha-2 country code, uppercase. The resulting address always has two bytes at it.
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
Hash Maps for Decoding
hashMapUtf8 :: Map Source #
hashMapUtf16 :: Map Source #