Data.TypedEncoding.Common.Class.Util.StringConstraints

ToStrInj and ToStrIso are future replacement for Data.TypedEncoding.Common.Class.IsStringR (currently not used).

Documentation

>>> :set -XScopedTypeVariables -XTypeApplications -XAllowAmbiguousTypes
>>> import Test.QuickCheck
>>> import Test.QuickCheck.Instances.Text()
>>> import Test.QuickCheck.Instances.ByteString()

IsString reversal

class ToStrInj str from where

Reverses IsString

law for types that are also IsString:

 toString . fromString == id

Note: ByteString is not a valid instance, ByteString "r-ASCII", or "r-UTF8" would be needed. B8.unpack $ B8.pack "160688" == "176"

This class is separated from ToStrIso to allow instances from smaller types the can inject into the String type.

Since: 0.3.0.0

Methods

toString :: from -> str

Instances

ToStrInj String String

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

toString :: String -> String

ToStrInj String Text

prop_toStringFromString (Proxy :: Proxy TL.Text)

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

toString :: Text -> String

ToStrInj String Text

prop_toStringFromString (Proxy :: Proxy T.Text)

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

toString :: Text -> String

prop_toStringFromString :: forall s. (IsString s, ToStrInj String s) => Proxy s -> String -> Bool

class ToStrInj str from => ToStrIso str from

Same as ToStrInj but with additional

law for types that are also IsString: fromString . toString == id

Since: 0.3.0.0

Instances

ToStrIso String String

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

ToStrIso String Text

prop_fromStringToString @TL.Text

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

ToStrIso String Text

prop_fromStringToString @T.Text

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

prop_fromStringToString :: forall s. (IsString s, ToStrIso String s, Eq s) => s -> Bool

class Char8Find str where

Used to find exceptions that violated "r-" encoding Expected to be used to check encoding of ASCII-7 so Text and ByteString are compatible or to check 0-255 range restrictions.

Since: 0.3.0.0

Methods

find :: (Char -> Bool) -> str -> Maybe Char

Instances

Char8Find String

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

find :: (Char -> Bool) -> String -> Maybe Char

Char8Find ByteString

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

find :: (Char -> Bool) -> ByteString -> Maybe Char

Char8Find ByteString

B8.pack is basically a convenient way to get Word8 elements into ByteString.

During B8.pack conversion charters are downsized to the 0-255 range (become a Word8). The length is preserved.

>>> B8.pack "\160582"
"F"

>>> B.length $ B8.pack "\160582"
1

This instance allows to check elements of ByteString interpreting them as Char.

Safe if restricting to 7bit code points.

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

find :: (Char -> Bool) -> ByteString -> Maybe Char

Char8Find Text

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

find :: (Char -> Bool) -> Text -> Maybe Char

Char8Find Text

Defined in Data.TypedEncoding.Common.Class.Util.StringConstraints

Methods

find :: (Char -> Bool) -> Text -> Maybe Char