Data.Textual

Working with human-friendly (as opposed to the compiler-friendly Show and Read) textual representations.

Printing

class Printable α where

The default printer for values of a type.

Methods

print :: Printer p => α -> p

Instances

Printable Char

Printable Double

Printable Float

Printable Int

Printable Int8

Printable Int16

Printable Int32

Printable Int64

Printable Integer

Printable Word

Printable Word8

Printable Word16

Printable Word32

Printable Word64

Printable String

Printable Text

Printable Text

maybePrint :: (Printer p, Printable α) => Maybe α -> p

A shorthand for maybe mempty print.

toString :: Printable α => α -> String

A shorthand for buildString . print.

toText :: Printable α => α -> Text

A shorthand for buildText . print.

toLazyText :: Printable α => α -> Text

A shorthand for buildLazyText . print.

toAscii :: Printable α => α -> ByteString

A shorthand for buildAscii . print.

toLazyAscii :: Printable α => α -> ByteString

A shorthand for buildLazyAscii . print.

toUtf8 :: Printable α => α -> ByteString

A shorthand for buildUtf8 . print.

toLazyUtf8 :: Printable α => α -> ByteString

A shorthand for buildLazyUtf8 . print.

Parsing

class Printable α => Textual α where

The default parser for values of a type, must satisfy fromString (toString x) = Just x

Methods

textual :: (Monad μ, CharParsing μ) => μ α

Instances

Textual Char

Textual Int

Textual Int8

Textual Int16

Textual Int32

Textual Int64

Textual Integer

Textual Word

Textual Word8

Textual Word16

Textual Word32

Textual Word64

Standard types proxies

hintType :: α -> Proxy α -> α

Hint the type system about the type of the first argument.

hintType1 :: f α -> Proxy f -> f α

Hint the type system about the type constructor.

hintTypeArg :: f α -> Proxy α -> f α

Hint the type system about the type argument.

aUnit :: Proxy ()

() proxy value.

aChar :: Proxy Char

Char proxy value.

anInteger :: Proxy Integer

Integer proxy value.

anInt :: Proxy Int

Int proxy value.

anInt8 :: Proxy Int8

Int8 proxy value.

anInt16 :: Proxy Int16

Int16 proxy value.

anInt32 :: Proxy Int32

Int32 proxy value.

anInt64 :: Proxy Int64

Int64 proxy value.

aWord :: Proxy Word

Word proxy value.

aWord8 :: Proxy Word8

Word8 proxy value.

aWord16 :: Proxy Word16

Word16 proxy value.

aWord32 :: Proxy Word32

Word32 proxy value.

aWord64 :: Proxy Word64

Word64 proxy value.

aFloat :: Proxy Float

Float proxy value.

aDouble :: Proxy Double

Double proxy value.

aMaybe :: Proxy Maybe

Maybe proxy value.

aMaybeOf :: Proxy α -> Proxy (Maybe α)

Maybe α proxy value.

aList :: Proxy []

List proxy value.

aListOf :: Proxy α -> Proxy [α]

List of α proxy value.

Built-in parser

data Parsed α

Parsing result.

Constructors

Parsed α

Malformed [String] String

Instances

Functor Parsed

Typeable1 Parsed

Applicative Parsed

Foldable Parsed

Traversable Parsed

Alternative Parsed

Eq α => Eq (Parsed α)

Show α => Show (Parsed α)

isParsed :: Parsed α -> Bool

Map Parsed to True and Malformed to False.

isMalformed :: Parsed α -> Bool

Map Parsed to False and Malformed to True.

maybeParsed :: Parsed α -> Maybe α

Map Parsed values to Just and Malformed to Nothing.

builtInParser :: (forall μ. (Monad μ, CharParsing μ) => μ α) -> String -> Parsed α

Use the built-in parser to parse a string. Intended for testing only.

parseString :: Textual α => String -> Parsed α

Parse a String to extract the Textual value.

parseStringAs :: Textual α => Proxy α -> String -> Parsed α

Provide a hint for the type system when using parseString.

parseText :: Textual α => Text -> Parsed α

Parse a Text to extract the Textual value.

parseTextAs :: Textual α => Proxy α -> Text -> Parsed α

Provide a hint for the type system when using parseText.

parseLazyText :: Textual α => Text -> Parsed α

Parse a lazy Text to extract the Textual value.

parseLazyTextAs :: Textual α => Proxy α -> Text -> Parsed α

Provide a hint for the type system when using parseLazyText.

parseAscii :: Textual α => ByteString -> Parsed α

Decode and parse an ASCII ByteString to extract the Textual value.

parseAsciiAs :: Textual α => Proxy α -> ByteString -> Parsed α

Provide a hint for the type system when using parseAscii.

parseLazyAscii :: Textual α => ByteString -> Parsed α

Decode and parse a lazy ASCII ByteString to extract the Textual value.

parseLazyAsciiAs :: Textual α => ByteString -> Parsed α

Provide a hint for the type system when using parseLazyAscii.

parseUtf8 :: Textual α => ByteString -> Parsed α

Decode and parse a UTF-8 ByteString to extract the Textual value.

parseUtf8As :: Textual α => Proxy α -> ByteString -> Parsed α

Provide a hint for the type system when using parseUtf8.

parseLazyUtf8 :: Textual α => ByteString -> Parsed α

Decode and parse a lazy UTF-8 ByteString to extract the Textual value.

parseLazyUtf8As :: Textual α => Proxy α -> ByteString -> Parsed α

Provide a hint for the type system when using parseLazyUtf8.

fromString :: Textual α => String -> Maybe α

A shorthand for maybeParsed . parseString

fromStringAs :: Textual α => Proxy α -> String -> Maybe α

Provide a hint for the type system when using fromString.

fromText :: Textual α => Text -> Maybe α

A shorthand for maybeParsed . parseText

fromTextAs :: Textual α => Proxy α -> Text -> Maybe α

Provide a hint for the type system when using fromText.

fromLazyText :: Textual α => Text -> Maybe α

A shorthand for maybeParsed . parseLazyText

fromLazyTextAs :: Textual α => Proxy α -> Text -> Maybe α

Provide a hint for the type system when using fromLazyText.

fromAscii :: Textual α => ByteString -> Maybe α

A shorthand for maybeParsed . parseAscii

fromAsciiAs :: Textual α => Proxy α -> ByteString -> Maybe α

Provide a hint for the type system when using fromAscii.

fromLazyAscii :: Textual α => ByteString -> Maybe α

A shorthand for maybeParsed . parseLazyAscii

fromLazyAsciiAs :: Textual α => Proxy α -> ByteString -> Maybe α

Provide a hint for the type system when using fromLazyAscii.

fromUtf8 :: Textual α => ByteString -> Maybe α

A shorthand for maybeParsed . parseUtf8

fromUtf8As :: Textual α => Proxy α -> ByteString -> Maybe α

Provide a hint for the type system when using fromUtf8.

fromLazyUtf8 :: Textual α => ByteString -> Maybe α

A shorthand for maybeParsed . parseLazyUtf8

fromLazyUtf8As :: Textual α => Proxy α -> ByteString -> Maybe α

Provide a hint for the type system when using fromLazyUtf8.