Country

Country type and helpers.

Documentation

data Country

A country recognized by ISO 3166.

Instances

FromJSON Country

Defined in Country.Unexposed.Names

Methods

parseJSON :: Value -> Parser Country

parseJSONList :: Value -> Parser [Country]

ToJSON Country

Defined in Country.Unexposed.Names

Methods

toJSON :: Country -> Value

toEncoding :: Country -> Encoding

toJSONList :: [Country] -> Value

toEncodingList :: [Country] -> Encoding

Data Country

Defined in Country.Unexposed.Names

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Country -> c Country

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Country

toConstr :: Country -> Constr

dataTypeOf :: Country -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Country)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Country)

gmapT :: (forall b. Data b => b -> b) -> Country -> Country

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Country -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Country -> r

gmapQ :: (forall d. Data d => d -> u) -> Country -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Country -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Country -> m Country

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Country -> m Country

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Country -> m Country

Storable Country

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 ()

Bounded Country

Defined in Country.Unexposed.Names

Methods

minBound :: Country

maxBound :: Country

Enum Country

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]

Generic Country

Defined in Country.Unexposed.Names

Associated Types

type Rep Country :: Type -> Type

Methods

from :: Country -> Rep Country x

to :: Rep Country x -> Country

Show Country

Defined in Country.Unexposed.Names

Methods

showsPrec :: Int -> Country -> ShowS

show :: Country -> String

showList :: [Country] -> ShowS

NFData Country

Defined in Country.Unexposed.Names

Methods

rnf :: Country -> ()

Eq Country

Defined in Country.Unexposed.Names

Methods

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

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

Ord Country

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

Hashable Country

Defined in Country.Unexposed.Names

Methods

hashWithSalt :: Int -> Country -> Int

hash :: Country -> Int

Prim Country

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

Defined in Country.Unexposed.Names

type Rep Country = D1 ('MetaData "Country" "Country.Unexposed.Names" "country-0.2.3.1-6nZ7UbiucZ9C0Po2c1kw39" '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

encodeEnglishShort :: Country -> ShortText

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 there are names that are missing.

decodeUtf8 :: ByteString -> Maybe Country

Decode a Country from a UTF-8-encoded ByteString.

decodeUtf8Bytes :: Bytes -> 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

Parse a Country using an Parser.

Alpha-2 and Alpha-3

alphaTwoUpper :: Country -> Text

The alpha-2 country code, uppercase

alphaTwoUpperUtf8Ptr :: Country -> Ptr Word8

The alpha-2 country code, uppercase. The resulting address always has two bytes at it.

alphaTwoUpperUtf8BoundedBuilder :: Country -> Builder 2

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

Decode a Country using its alpha-2 country code.

decodeAlphaThree :: Text -> Maybe Country

Decode a Country using its alpha-3 country code.

Hash Maps for Decoding

hashMapUtf8 :: Map

hashMapUtf16 :: Map