Data.TypedEncoding.Combinators.Restriction.BoundedAlphaNums

Restrictions "r-ban:" cover commonly used fixed (short) size strings with restricted characters such as GUID, credit card numbers, etc.

Alphanumeric chars are ordered: 0-9 followed by a-z followed by A-Z. Annotation specifies upper character bound. Any non alpha numeric characters are considered fixed delimiters and need to be present exactly as specified. For example "r-ban:999-99-9999" could be used to describe SSN numbers, @"r-ban:ffff" would describe strings consisting of 4 hex digits.

This is a simple implementation that converts to String, should be used only with short length data.

This module does not create instances of EncodeF typeclass to avoid duplicate instance issues.

Decoding function decFR is located in Data.TypedEncoding.Combinators.Restriction.Common

Use recWithEncR to create manual recovery step that can be combined with recreateFPart.

Since: 0.2.1.0

Documentation

>>> :set -XOverloadedStrings -XMultiParamTypeClasses -XDataKinds -XTypeApplications
>>> import qualified Data.Text as T
>>> import           Data.TypedEncoding.Combinators.Restriction.Common

type family IsBan (s :: Symbol) :: Bool where ...

Equations

IsBan s = AcceptEq (Text "Not ban restriction encoding " :<>: ShowType s) (CmpSymbol "r-ban:" (Take 6 s))

encFBan :: forall f s t xs c str. (IsStringR str, KnownSymbol s, IsBan s ~ True, f ~ Either EncodeEx) => Enc xs c str -> f (Enc (s ': xs) c str)

>>> encFBan . toEncoding () $ "c59f9fb7-4621-44d9-9020-ce37bf6e2bd1" :: Either EncodeEx (Enc '["r-ban:ffffffff-ffff-ffff-ffff-ffffffffffff"] () T.Text)
Right (MkEnc Proxy () "c59f9fb7-4621-44d9-9020-ce37bf6e2bd1")

>>> recWithEncR encFBan . toEncoding () $ "211-22-9934" :: Either RecreateEx (Enc '["r-ban:999-99-9999"] () T.Text)
Right (MkEnc Proxy () "211-22-9934")

verifyBoundedAlphaNum :: forall s a str. (KnownSymbol s, IsStringR str) => Proxy s -> str -> Either String str

>>> verifyBoundedAlphaNum (Proxy :: Proxy "r-ban:ff-ff") (T.pack "12-3e")
Right "12-3e"
>>> verifyBoundedAlphaNum (Proxy :: Proxy "r-ban:ff-ff") (T.pack "1g-3e")
Left "'g' not boulded by 'f'"
>>> verifyBoundedAlphaNum (Proxy :: Proxy "r-ban:ff-ff") (T.pack "13g3e")
Left "'g' not matching '-'"
>>> verifyBoundedAlphaNum (Proxy :: Proxy "r-ban:ff-ff") (T.pack "13-234")
Left "Input list has wrong size expecting 5 but length \"13-234\" == 6"