Haspara.Currency

This module provides definitions for modeling and working with currencies.

Currency

newtype Currency

Type encoding for currency symbol values with a syntax of [A-Z]{3}[A-Z]*.

Currency values can be constructed via mkCurrencyError that works in MonadError Text context:

>>> mkCurrencyError "EUR" :: Either T.Text Currency
Right EUR

... or via mkCurrencyFail that works in MonadFail context:

>>> mkCurrencyFail "EUR" :: Maybe Currency
Just EUR

An IsString instance is provided as well which is unsafe but convenient:

>>> "EUR" :: Currency
EUR

Constructors

MkCurrency

Fields

• currencyCode :: Text

Instances

Eq Currency

Defined in Haspara.Currency

Methods

(==) :: Currency -> Currency -> Bool

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

Ord Currency

Defined in Haspara.Currency

Methods

compare :: Currency -> Currency -> Ordering

(<) :: Currency -> Currency -> Bool

(<=) :: Currency -> Currency -> Bool

(>) :: Currency -> Currency -> Bool

(>=) :: Currency -> Currency -> Bool

max :: Currency -> Currency -> Currency

min :: Currency -> Currency -> Currency

Show Currency

Show instance for Currency.

>>> "USD" :: Currency
USD

Defined in Haspara.Currency

Methods

showsPrec :: Int -> Currency -> ShowS

show :: Currency -> String

showList :: [Currency] -> ShowS

IsString Currency

IsString instance for Currency.

>>> "USD" :: Currency
USD

Defined in Haspara.Currency

Methods

fromString :: String -> Currency

Hashable Currency

Defined in Haspara.Currency

Methods

hashWithSalt :: Int -> Currency -> Int

hash :: Currency -> Int

ToJSON Currency

ToJSON instance for Currency.

>>> Aeson.encode ("USD" :: Currency)
"\"USD\""

Defined in Haspara.Currency

Methods

toJSON :: Currency -> Value

toEncoding :: Currency -> Encoding

toJSONList :: [Currency] -> Value

toEncodingList :: [Currency] -> Encoding

FromJSON Currency

FromJSON instance for Currency.

>>> Aeson.eitherDecode "\"\"" :: Either String Currency
Left "Error in $: Currency code error! Expecting at least 3 uppercase ASCII letters, but received: "
>>> Aeson.eitherDecode "\"A\"" :: Either String Currency
Left "Error in $: Currency code error! Expecting at least 3 uppercase ASCII letters, but received: A"
>>> Aeson.eitherDecode "\"AB\"" :: Either String Currency
Left "Error in $: Currency code error! Expecting at least 3 uppercase ASCII letters, but received: AB"
>>> Aeson.eitherDecode "\"ABC\"" :: Either String Currency
Right ABC
>>> Aeson.eitherDecode "\"ABCD\"" :: Either String Currency
Right ABCD

Defined in Haspara.Currency

Methods

parseJSON :: Value -> Parser Currency

parseJSONList :: Value -> Parser [Currency]

Lift Currency

Defined in Haspara.Currency

Methods

lift :: Currency -> Q Exp

liftTyped :: Currency -> Q (TExp Currency)

mkCurrencyError :: MonadError Text m => Text -> m Currency

Smart constructor for Currency values within MonadError context.

>>> mkCurrencyError "" :: Either T.Text Currency
Left "Currency code error! Expecting at least 3 uppercase ASCII letters, but received: "
>>> mkCurrencyError " " :: Either T.Text Currency
Left "Currency code error! Expecting at least 3 uppercase ASCII letters, but received:  "
>>> mkCurrencyError "AB" :: Either T.Text Currency
Left "Currency code error! Expecting at least 3 uppercase ASCII letters, but received: AB"
>>> mkCurrencyError " ABC " :: Either T.Text Currency
Left "Currency code error! Expecting at least 3 uppercase ASCII letters, but received:  ABC "
>>> mkCurrencyError "ABC" :: Either T.Text Currency
Right ABC

mkCurrencyFail :: MonadFail m => Text -> m Currency

Smart constructor for Currency values within MonadFail context.

>>> mkCurrencyFail "" :: Maybe Currency
Nothing
>>> mkCurrencyFail "US" :: Maybe Currency
Nothing
>>> mkCurrencyFail "usd" :: Maybe Currency
Nothing
>>> mkCurrencyFail "USD" :: Maybe Currency
Just USD

currencyCodeParser :: Parsec Void Text Text

Parser that parses currency codes.

>>> MP.runParser currencyCodeParser "Example" ""
Left (ParseErrorBundle {bundleErrors = TrivialError 0 (Just EndOfInput) (fromList []) :| [], bundlePosState = PosState {pstateInput = "", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})
>>> MP.runParser currencyCodeParser "Example" " "
Left (ParseErrorBundle {bundleErrors = TrivialError 0 (Just (Tokens (' ' :| ""))) (fromList []) :| [], bundlePosState = PosState {pstateInput = " ", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})
>>> MP.runParser currencyCodeParser "Example" "a"
Left (ParseErrorBundle {bundleErrors = TrivialError 0 (Just (Tokens ('a' :| ""))) (fromList []) :| [], bundlePosState = PosState {pstateInput = "a", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})
>>> MP.runParser currencyCodeParser "Example" "A"
Left (ParseErrorBundle {bundleErrors = TrivialError 1 (Just EndOfInput) (fromList []) :| [], bundlePosState = PosState {pstateInput = "A", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})
>>> MP.runParser currencyCodeParser "Example" "AB"
Left (ParseErrorBundle {bundleErrors = TrivialError 2 (Just EndOfInput) (fromList []) :| [], bundlePosState = PosState {pstateInput = "AB", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})
>>> MP.runParser currencyCodeParser "Example" "ABC"
Right "ABC"
>>> MP.runParser currencyCodeParser "Example" "ABCD"
Right "ABCD"
>>> MP.runParser currencyCodeParser "Example" " ABCD "
Left (ParseErrorBundle {bundleErrors = TrivialError 0 (Just (Tokens (' ' :| ""))) (fromList []) :| [], bundlePosState = PosState {pstateInput = " ABCD ", pstateOffset = 0, pstateSourcePos = SourcePos {sourceName = "Example", sourceLine = Pos 1, sourceColumn = Pos 1}, pstateTabWidth = Pos 8, pstateLinePrefix = ""}})

Currency Pair

data CurrencyPair

Type encoding of a currency pair.

CurrencyPair values are constructed via the data constructor:

>>> CurrencyPair "EUR" "USD"
EUR/USD

FromJSON and ToJSON instances are provided as well:

>>> Aeson.decode "{\"base\": \"EUR\", \"quote\": \"EUR\"}" :: Maybe CurrencyPair
Just EUR/EUR
>>> Aeson.encode (CurrencyPair "EUR" "USD")
"{\"base\":\"EUR\",\"quote\":\"USD\"}"

Constructors

CurrencyPair

Fields

• currencyPairBase :: !Currency

  Base currency of the currency pair. Also referred to as counter currency.

• currencyPairQuote :: !Currency

  Quote currency of the currency pair. Also referred to as transaction currency.

Instances

Eq CurrencyPair

Defined in Haspara.Currency

Methods

(==) :: CurrencyPair -> CurrencyPair -> Bool

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

Ord CurrencyPair

Defined in Haspara.Currency

Methods

compare :: CurrencyPair -> CurrencyPair -> Ordering

(<) :: CurrencyPair -> CurrencyPair -> Bool

(<=) :: CurrencyPair -> CurrencyPair -> Bool

(>) :: CurrencyPair -> CurrencyPair -> Bool

(>=) :: CurrencyPair -> CurrencyPair -> Bool

max :: CurrencyPair -> CurrencyPair -> CurrencyPair

min :: CurrencyPair -> CurrencyPair -> CurrencyPair

Show CurrencyPair

Show instance for CurrencyPair.

>>> CurrencyPair "EUR" "USD"
EUR/USD

Defined in Haspara.Currency

Methods

showsPrec :: Int -> CurrencyPair -> ShowS

show :: CurrencyPair -> String

showList :: [CurrencyPair] -> ShowS

Generic CurrencyPair

Defined in Haspara.Currency

Associated Types

type Rep CurrencyPair :: Type -> Type

Methods

from :: CurrencyPair -> Rep CurrencyPair x

to :: Rep CurrencyPair x -> CurrencyPair

ToJSON CurrencyPair

Defined in Haspara.Currency

Methods

toJSON :: CurrencyPair -> Value

toEncoding :: CurrencyPair -> Encoding

toJSONList :: [CurrencyPair] -> Value

toEncodingList :: [CurrencyPair] -> Encoding

FromJSON CurrencyPair

Defined in Haspara.Currency

Methods

parseJSON :: Value -> Parser CurrencyPair

parseJSONList :: Value -> Parser [CurrencyPair]

Lift CurrencyPair

Defined in Haspara.Currency

Methods

lift :: CurrencyPair -> Q Exp

liftTyped :: CurrencyPair -> Q (TExp CurrencyPair)

type Rep CurrencyPair

Defined in Haspara.Currency

type Rep CurrencyPair = D1 ('MetaData "CurrencyPair" "Haspara.Currency" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'False) (C1 ('MetaCons "CurrencyPair" 'PrefixI 'True) (S1 ('MetaSel ('Just "currencyPairBase") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Currency) :*: S1 ('MetaSel ('Just "currencyPairQuote") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Currency)))

toCurrencyTuple :: CurrencyPair -> (Currency, Currency)

Converts a CurrencyPair to a 2-tuple of Currency values.

>>> toCurrencyTuple (CurrencyPair "EUR" "USD")
(EUR,USD)

fromCurrencyTuple :: (Currency, Currency) -> CurrencyPair

Converts a 2-tuple of Currency values to a CurrencyPair.

>>> fromCurrencyTuple ("EUR", "USD")
EUR/USD