Safe Haskell	None
Language	Haskell2010

Haspara.Internal.Currency

Contents

Data Definition
Constructors
Auxiliaries

Description

This module provides internal definitions for modeling and working with currencies.

Synopsis

newtype Currency = MkCurrency {
- currencyCode :: Text
}
currency :: MonadError String m => Text -> m Currency
currencyFail :: MonadFail m => Text -> m Currency
currencyCodeParser :: Parsec Void Text Text
newtype CurrencyPair = MkCurrencyPair {
- unCurrencyPair :: (Currency, Currency)
}
toTuple :: CurrencyPair -> (Currency, Currency)
baseCurrency :: CurrencyPair -> Currency
quoteCurrency :: CurrencyPair -> Currency
currencyPair :: MonadError String m => Currency -> Currency -> m CurrencyPair
currencyPairFail :: MonadFail m => Currency -> Currency -> m CurrencyPair

Data Definition

newtype Currency Source #

Type encoding for currencies.

Constructors

MkCurrency
Fields currencyCode :: Text

Instances

Instances details

Eq Currency Source #
Instance details Defined in Haspara.Internal.Currency Methods (==) :: Currency -> Currency -> Bool # (/=) :: Currency -> Currency -> Bool #
Ord Currency Source #
Instance details Defined in Haspara.Internal.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 Source #	`Show` instance for `Currency`. `>>>` `MkCurrency "USD"`USD
Instance details Defined in Haspara.Internal.Currency Methods showsPrec :: Int -> Currency -> ShowS # show :: Currency -> String # showList :: [Currency] -> ShowS #
IsString Currency Source #	`IsString` instance for `Currency`. `>>>` `"USD" :: Currency`USD
Instance details Defined in Haspara.Internal.Currency Methods fromString :: String -> Currency #
Hashable Currency Source #
Instance details Defined in Haspara.Internal.Currency Methods hashWithSalt :: Int -> Currency -> Int # hash :: Currency -> Int #
ToJSON Currency Source #	`ToJSON` instance for `Currency`. `>>>` `Aeson.encode (MkCurrency "USD")`"\"USD\""
Instance details Defined in Haspara.Internal.Currency Methods toJSON :: Currency -> Value # toEncoding :: Currency -> Encoding # toJSONList :: [Currency] -> Value # toEncodingList :: [Currency] -> Encoding #
FromJSON Currency Source #	`FromJSON` instance for `Currency`. `>>>` `Aeson.eitherDecode "\"\"" :: Either String Currency`Left "Error in $: Currency code error! Expecting at least 3 uppercase characters, but received: \"\"" `>>>` `Aeson.eitherDecode "\"ABC\"" :: Either String Currency`Right ABC
Instance details Defined in Haspara.Internal.Currency Methods parseJSON :: Value -> Parser Currency # parseJSONList :: Value -> Parser [Currency] #
Lift Currency Source #
Instance details Defined in Haspara.Internal.Currency Methods lift :: Currency -> Q Exp # liftTyped :: Currency -> Q (TExp Currency) #

Constructors

currency :: MonadError String m => Text -> m Currency Source #

Smart constructor for Currency values within MonadError context.

>>> currency "" :: Either String Currency
Left "Currency code error! Expecting at least 3 uppercase characters, but received: \"\""
>>> currency " " :: Either String Currency
Left "Currency code error! Expecting at least 3 uppercase characters, but received: \" \""
>>> currency "AB" :: Either String Currency
Left "Currency code error! Expecting at least 3 uppercase characters, but received: \"AB\""
>>> currency " ABC " :: Either String Currency
Left "Currency code error! Expecting at least 3 uppercase characters, but received: \" ABC \""
>>> currency "ABC" :: Either String Currency
Right ABC

currencyFail :: MonadFail m => Text -> m Currency Source #

Smart constructor for Currency values within MonadFail context.

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

Auxiliaries

currencyCodeParser :: Parsec Void Text Text Source #

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"

newtype CurrencyPair Source #

Constructors

MkCurrencyPair
Fields unCurrencyPair :: (Currency, Currency)

Instances

Instances details

Eq CurrencyPair Source #
Instance details Defined in Haspara.Internal.Currency Methods (==) :: CurrencyPair -> CurrencyPair -> Bool # (/=) :: CurrencyPair -> CurrencyPair -> Bool #
Ord CurrencyPair Source #
Instance details Defined in Haspara.Internal.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 Source #	`Show` instance for currency pairs. `>>>` `MkCurrencyPair ("EUR", "USD")`EUR/USD
Instance details Defined in Haspara.Internal.Currency Methods showsPrec :: Int -> CurrencyPair -> ShowS # show :: CurrencyPair -> String # showList :: [CurrencyPair] -> ShowS #
Hashable CurrencyPair Source #
Instance details Defined in Haspara.Internal.Currency Methods hashWithSalt :: Int -> CurrencyPair -> Int # hash :: CurrencyPair -> Int #
Lift CurrencyPair Source #
Instance details Defined in Haspara.Internal.Currency Methods lift :: CurrencyPair -> Q Exp # liftTyped :: CurrencyPair -> Q (TExp CurrencyPair) #

toTuple :: CurrencyPair -> (Currency, Currency) Source #

baseCurrency :: CurrencyPair -> Currency Source #

quoteCurrency :: CurrencyPair -> Currency Source #

currencyPair :: MonadError String m => Currency -> Currency -> m CurrencyPair Source #

currencyPairFail :: MonadFail m => Currency -> Currency -> m CurrencyPair Source #