Moduledata-textual-0.3.0.3Haskell2010

Data.Textual

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

1 type
2 classes
40 values

Packagedata-textual-0.3.0.3
Exports43
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTextual.hs

Printing

9 declarations

classclass Printable α where

The default printer for values of a type.

Methods

print :: Printer p => α -> p

Instances19Printable, …

Printable StringDefined in data-textual-0.3.0.3 · Data.Textual
Printable IntegerDefined in data-textual-0.3.0.3 · Data.Textual
Printable Int16Defined in data-textual-0.3.0.3 · Data.Textual
Printable Int32Defined in data-textual-0.3.0.3 · Data.Textual
Printable Int64Defined in data-textual-0.3.0.3 · Data.Textual
Printable Int8Defined in data-textual-0.3.0.3 · Data.Textual
Printable CharDefined in data-textual-0.3.0.3 · Data.Textual
Printable DoubleDefined in data-textual-0.3.0.3 · Data.Textual
Printable FloatDefined in data-textual-0.3.0.3 · Data.Textual
Printable IntDefined in data-textual-0.3.0.3 · Data.Textual
Printable WordDefined in data-textual-0.3.0.3 · Data.Textual
Printable Word16Defined in data-textual-0.3.0.3 · Data.Textual
Printable Word32Defined in data-textual-0.3.0.3 · Data.Textual
Printable Word64Defined in data-textual-0.3.0.3 · Data.Textual
Printable Word8Defined in data-textual-0.3.0.3 · Data.Textual
Printable TextDefined in data-textual-0.3.0.3 · Data.Textual
Printable TextDefined in data-textual-0.3.0.3 · Data.Textual
Integral α => Printable (Ratio α)Defined in data-textual-0.3.0.3 · Data.Textual
HasResolution α => Printable (Fixed α)Defined in data-textual-0.3.0.3 · Data.Textual

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

A shorthand for maybe mempty print.

valuetoString :: Printable α => α -> String

A shorthand for buildString . print.

valuetoText :: Printable α => α -> Text

A shorthand for buildText . print.

valuetoLazyText :: Printable α => α -> Text

A shorthand for buildLazyText . print.

valuetoAscii :: Printable α => α -> ByteString

A shorthand for buildAscii . print.

valuetoLazyAscii :: Printable α => α -> ByteString

A shorthand for buildLazyAscii . print.

valuetoUtf8 :: Printable α => α -> ByteString

A shorthand for buildUtf8 . print.

valuetoLazyUtf8 :: Printable α => α -> ByteString

A shorthand for buildLazyUtf8 . print.

Parsing

1 declaration

classclass Printable α => Textual α where

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

Methods

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

Instances14Textual, …

Textual IntegerDefined in data-textual-0.3.0.3 · Data.Textual
Textual Int16Defined in data-textual-0.3.0.3 · Data.Textual
Textual Int32Defined in data-textual-0.3.0.3 · Data.Textual
Textual Int64Defined in data-textual-0.3.0.3 · Data.Textual
Textual Int8Defined in data-textual-0.3.0.3 · Data.Textual
Textual CharDefined in data-textual-0.3.0.3 · Data.Textual
Textual IntDefined in data-textual-0.3.0.3 · Data.Textual
Textual WordDefined in data-textual-0.3.0.3 · Data.Textual
Textual Word16Defined in data-textual-0.3.0.3 · Data.Textual
Textual Word32Defined in data-textual-0.3.0.3 · Data.Textual
Textual Word64Defined in data-textual-0.3.0.3 · Data.Textual
Textual Word8Defined in data-textual-0.3.0.3 · Data.Textual
Integral α => Textual (Ratio α)Defined in data-textual-0.3.0.3 · Data.Textual
HasResolution α => Textual (Fixed α)Defined in data-textual-0.3.0.3 · Data.Textual

Built-in parser

datadata Parsed α

Parsing result.

Constructors

Parsed α
Malformed [String] String

Instances7Functor, Applicative, Foldable, Traversable, Alternative, Eq, …

Functor ParsedDefined in data-textual-0.3.0.3 · Data.Textual
Applicative ParsedDefined in data-textual-0.3.0.3 · Data.Textual
Foldable ParsedDefined in data-textual-0.3.0.3 · Data.Textual
Traversable ParsedDefined in data-textual-0.3.0.3 · Data.Textual
Alternative ParsedDefined in data-textual-0.3.0.3 · Data.Textual
Eq α => Eq (Parsed α)Defined in data-textual-0.3.0.3 · Data.Textual
Show α => Show (Parsed α)Defined in data-textual-0.3.0.3 · Data.Textual

valueisParsed :: Parsed α -> Bool

Map Parsed to True and Malformed to False.

valueisMalformed :: Parsed α -> Bool

Map Parsed to False and Malformed to True.

valuemaybeParsed :: Parsed α -> Maybe α

Map Parsed values to Just and Malformed to Nothing.

valuebuiltInParser

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

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

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

Parse a String to extract the Textual value.

valueparseStringAs :: Textual α => p α -> String -> Parsed α

Provide a hint for the type system when using parseString.

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

Parse a Text to extract the Textual value.

valueparseTextAs :: Textual α => p α -> Text -> Parsed α

Provide a hint for the type system when using parseText.

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

Parse a lazy Text to extract the Textual value.

valueparseLazyTextAs :: Textual α => p α -> Text -> Parsed α

Provide a hint for the type system when using parseLazyText.

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

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

valueparseAsciiAs :: Textual α => p α -> ByteString -> Parsed α

Provide a hint for the type system when using parseAscii.

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

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

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

Provide a hint for the type system when using parseLazyAscii.

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

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

valueparseUtf8As :: Textual α => p α -> ByteString -> Parsed α

Provide a hint for the type system when using parseUtf8.

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

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

valueparseLazyUtf8As :: Textual α => p α -> ByteString -> Parsed α

Provide a hint for the type system when using parseLazyUtf8.

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

A shorthand for maybeParsed . parseString

valuefromStringAs :: Textual α => p α -> String -> Maybe α

Provide a hint for the type system when using fromString.

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

A shorthand for maybeParsed . parseText

valuefromTextAs :: Textual α => p α -> Text -> Maybe α

Provide a hint for the type system when using fromText.

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

A shorthand for maybeParsed . parseLazyText

valuefromLazyTextAs :: Textual α => p α -> Text -> Maybe α

Provide a hint for the type system when using fromLazyText.

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

A shorthand for maybeParsed . parseAscii

valuefromAsciiAs :: Textual α => p α -> ByteString -> Maybe α

Provide a hint for the type system when using fromAscii.

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

A shorthand for maybeParsed . parseLazyAscii

valuefromLazyAsciiAs :: Textual α => p α -> ByteString -> Maybe α

Provide a hint for the type system when using fromLazyAscii.

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

A shorthand for maybeParsed . parseUtf8

valuefromUtf8As :: Textual α => p α -> ByteString -> Maybe α

Provide a hint for the type system when using fromUtf8.

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

A shorthand for maybeParsed . parseLazyUtf8

valuefromLazyUtf8As :: Textual α => p α -> ByteString -> Maybe α

Provide a hint for the type system when using fromLazyUtf8.