Finance.Belgium.StructuredCommunication

Belgian companies often make use of structured communication with a checksum. This package aims to provide a toolkit to parse, render and manipulate StructuredCommunication.

Constructing StructuredCommunication

data StructuredCommunication

A data type that stores three numbers: one with three digits (000–999), four digits (0000–9999) and five digits (00001–99997). The data constructor itself is not accessible, since the StructuredCommunication could produce objects that are out of the given ranges, or where the checksum is not valid. The module thus aims to prevent parsing, changing, etc. StructuredCommunication objects into an invalid state.

Constructors

StructuredCommunication !Word16 !Word16 !Word32

Instances

Arbitrary StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

arbitrary :: Gen StructuredCommunication

shrink :: StructuredCommunication -> [StructuredCommunication]

Data StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

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

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

toConstr :: StructuredCommunication -> Constr

dataTypeOf :: StructuredCommunication -> DataType

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

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

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

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

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

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

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

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

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

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

Bounded StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

minBound :: StructuredCommunication

maxBound :: StructuredCommunication

Enum StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

succ :: StructuredCommunication -> StructuredCommunication

pred :: StructuredCommunication -> StructuredCommunication

toEnum :: Int -> StructuredCommunication

fromEnum :: StructuredCommunication -> Int

enumFrom :: StructuredCommunication -> [StructuredCommunication]

enumFromThen :: StructuredCommunication -> StructuredCommunication -> [StructuredCommunication]

enumFromTo :: StructuredCommunication -> StructuredCommunication -> [StructuredCommunication]

enumFromThenTo :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication -> [StructuredCommunication]

Generic StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Associated Types

type Rep StructuredCommunication :: Type -> Type

Methods

from :: StructuredCommunication -> Rep StructuredCommunication x

to :: Rep StructuredCommunication x -> StructuredCommunication

Num StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

(+) :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

(-) :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

(*) :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

negate :: StructuredCommunication -> StructuredCommunication

abs :: StructuredCommunication -> StructuredCommunication

signum :: StructuredCommunication -> StructuredCommunication

fromInteger :: Integer -> StructuredCommunication

Read StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

readsPrec :: Int -> ReadS StructuredCommunication

readList :: ReadS [StructuredCommunication]

readPrec :: ReadPrec StructuredCommunication

readListPrec :: ReadPrec [StructuredCommunication]

Integral StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

quot :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

rem :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

div :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

mod :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

quotRem :: StructuredCommunication -> StructuredCommunication -> (StructuredCommunication, StructuredCommunication)

divMod :: StructuredCommunication -> StructuredCommunication -> (StructuredCommunication, StructuredCommunication)

toInteger :: StructuredCommunication -> Integer

Real StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

toRational :: StructuredCommunication -> Rational

Show StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

showsPrec :: Int -> StructuredCommunication -> ShowS

show :: StructuredCommunication -> String

showList :: [StructuredCommunication] -> ShowS

Binary StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

put :: StructuredCommunication -> Put

get :: Get StructuredCommunication

putList :: [StructuredCommunication] -> Put

Eq StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

(==) :: StructuredCommunication -> StructuredCommunication -> Bool

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

Ord StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

compare :: StructuredCommunication -> StructuredCommunication -> Ordering

(<) :: StructuredCommunication -> StructuredCommunication -> Bool

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

(>) :: StructuredCommunication -> StructuredCommunication -> Bool

(>=) :: StructuredCommunication -> StructuredCommunication -> Bool

max :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

min :: StructuredCommunication -> StructuredCommunication -> StructuredCommunication

Hashable StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

hashWithSalt :: Int -> StructuredCommunication -> Int

hash :: StructuredCommunication -> Int

Random StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

randomR :: RandomGen g => (StructuredCommunication, StructuredCommunication) -> g -> (StructuredCommunication, g)

random :: RandomGen g => g -> (StructuredCommunication, g)

randomRs :: RandomGen g => (StructuredCommunication, StructuredCommunication) -> g -> [StructuredCommunication]

randoms :: RandomGen g => g -> [StructuredCommunication]

Uniform StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

uniformM :: StatefulGen g m => g -> m StructuredCommunication

UniformRange StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

uniformRM :: StatefulGen g m => (StructuredCommunication, StructuredCommunication) -> g -> m StructuredCommunication

Validity StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

validate :: StructuredCommunication -> Validation

Lift StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

Methods

lift :: Quote m => StructuredCommunication -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => StructuredCommunication -> Code m StructuredCommunication

type Rep StructuredCommunication

Defined in Finance.Belgium.StructuredCommunication

type Rep StructuredCommunication = D1 ('MetaData "StructuredCommunication" "Finance.Belgium.StructuredCommunication" "belgian-structured-communication-0.2.0.0-8vPNgodR9zmH8txhOlR1V0" 'False) (C1 ('MetaCons "StructuredCommunication" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32))))

structuredCommunication

Arguments

:: (Integral i, Integral j, Integral k)

=> i

The first number, should be between 000 and 999.

-> j

The second number, should be between 0000 and 9999.

-> k

The third number, should be between 00001 and 99997.

-> Maybe StructuredCommunication

The StructuredCommunication wrapped in a Just of the three numbers are in range, and the checksum matches, otherwise Nothing.

Construct a StructuredCommunication object for the given three integral values that form the three sequences of digits.

determining the checksum

checksum

Arguments

:: StructuredCommunication

The StructuredCommunication for which we determine the checkum.

-> Word32

The last two digits of the StructuredCommunication object. The checksum is not per se valid.

Determining the checksum-part for the given StructuredCommunication. This thus takes the last two digits, or the third number modulo one hundred.

determineChecksum

Arguments

:: StructuredCommunication

The StructuredCommunication to determine the checksum from.

-> Word32

The checksum determined by the first ten digits, not per se the real checksum of the StructuredCommunication.

Determine the checksum based on the first ten digits. If the StructuredCommunication is not valid, its checksum will not match the result of the determineChecksum.

validChecksum

Arguments

:: StructuredCommunication

The StructuredCommunication for which we check the checksum.

-> Bool

True if the checksum is valid; False otherwise.

Check if the checksum matches for the given StructuredCommunication.

fixChecksum

Arguments

:: StructuredCommunication

The given StructuredCommunication to fix.

-> StructuredCommunication

A variant of the given StructuredCommunication where only the last two digits are changed to have a valid checksum.

Convert the given StructuredCommunication to one where the checksum is valid. If the checksum was already valid, it returns an equivalent StructuredCommunication, this operation is thus idempotent.

Converting to text

communicationToString

Arguments

:: StructuredCommunication

The given StructuredCommunication to convert to a String.

-> String

The corresponding String, of the form +++000/0000/00097+++.

Convert the given StructuredCommunication to a String that looks like a structured communication, so +++000/0000/00097+++.

communicationToText

Arguments

:: StructuredCommunication

The given StructuredCommunication to convert to a Text.

-> Text

The corresponding Text, of the form +++000/0000/00097+++.

Convert the given StructuredCommunication to a Text that looks like a structured communication, so +++000/0000/00097+++.

Parsing from text

communicationParser

Arguments

:: Stream s m Char

=> ParsecT s u m StructuredCommunication

The ParsecT object that parses the structured communication of the form +++000/0000/00097+++.

A ParsecT that parses a string into a StructuredCommunication, the StructuredCommunication is checked for its validity (checksum). The parser does not (per se) ends with an eof.

communicationParser'

Arguments

:: Stream s m Char

=> ParsecT s u m StructuredCommunication

The ParsecT object that parses the structured communication of the form +++000/0000/00097+++.

A ParsecT that parses a string into a StructuredCommunication, the StructuredCommunication can be invalid. The parser also does not (per se) ends with an eof.

communicationEParser

Arguments

:: Stream s m Char

=> ParsecT s u m StructuredCommunication

The ParsecT object that parses the structured communication of the form +++000/0000/00097+++.

A ParsecT that parses a string into a StructuredCommunication, the StructuredCommunication is checked for its validity (checksum). The parser also checks that this is the end of the stream.

communicationEParser'

Arguments

:: Stream s m Char

=> ParsecT s u m StructuredCommunication

The ParsecT object that parses the structured communication of the form +++000/0000/00097+++.

A ParsecT that parses a string into a StructuredCommunication, the StructuredCommunication can be invalid. The parser also checks if this is the end of the stream.

parseCommunication

Arguments

:: Stream s Identity Char

=> s

The stream that is parsed into a StructuredCommunication

-> Either ParseError StructuredCommunication

The result of parsing, either a StructuredCommunication wrapped in a Right or a parsing error wrapped in a Left.

Parsing a stream into a StructuredCommunication that also validates the checksum of the communication. The stream does not per se needs to end with structured communcation.

parseCommunication'

Arguments

:: Stream s Identity Char

=> s

The stream that is parsed into a StructuredCommunication

-> Either ParseError StructuredCommunication

The result of parsing, either a StructuredCommunication wrapped in a Right or a parsing error wrapped in a Left.

Parsing a stream into a StructuredCommunication that does noet validate the checksum of the communication. The stream does not per se needs to end with structured communcation.

parseCommunicationE

Arguments

:: Stream s Identity Char

=> s

The stream that is parsed into a StructuredCommunication

-> Either ParseError StructuredCommunication

The result of parsing, either a StructuredCommunication wrapped in a Right or a parsing error wrapped in a Left.

Parsing a stream into a StructuredCommunication that also validates the checksum of the communication. After the structured communication, the stream needs to end.

parseCommunicationE'

Arguments

:: Stream s Identity Char

=> s

The stream that is parsed into a StructuredCommunication

-> Either ParseError StructuredCommunication

The result of parsing, either a StructuredCommunication wrapped in a Right or a parsing error wrapped in a Left.

Parsing a stream into a StructuredCommunication that does noet validate the checksum of the communication. After the structured communication, the stream needs to end.

Quasi quotation

beCommunication

Arguments

:: QuasiQuoter

A QuasiQuoter to parse to a StructuredCommunication.

A QuasiQuoter that can parse a string into an expression or pattern. It will thus convert +++000/000/00097+++ into a StructuredCommunication as expression or pattern.