TextBuilderDev · text-builder-dev-0.3.4.2

datadata TextBuilder

Specification of how to efficiently construct strict Text. Provides instances of Semigroup and Monoid, which have complexity of O(1).

Instances16Eq, Show, IsString, Semigroup, Monoid, Arbitrary, …

Eq TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
Show TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsString TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
Semigroup TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
Monoid TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
Arbitrary TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicToTextBuilder TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo String TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo Text TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo Builder TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo Text TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo TextBuilder StringDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo TextBuilder TextDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo TextBuilder BuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo TextBuilder TextDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicTo TextBuilder TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev

Accessors

3 declarations

valuebuildText :: TextBuilder -> Text

#

Execute a builder producing a strict text.

valuelength :: TextBuilder -> Int

#

Get the amount of characters.

valuenull :: TextBuilder -> Bool

#

Check whether the builder is empty.

Output IO

valueputToStdOut :: TextBuilder -> IO ()

#

Put builder, to stdout.

valueputToStdErr :: TextBuilder -> IO ()

#

Put builder, to stderr.

valueputLnToStdOut :: TextBuilder -> IO ()

#

Put builder, followed by a line, to stdout.

valueputLnToStdErr :: TextBuilder -> IO ()

#

Put builder, followed by a line, to stderr.

Constructors

0 declarations

Builder manipulators

valueforce :: TextBuilder -> TextBuilder

#

Run the builder and pack the produced text into a new builder.

Useful to have around builders that you reuse, because a forced builder is much faster, since it's virtually a single call memcopy.

valueintercalate :: Foldable f => TextBuilder -> f TextBuilder -> TextBuilder

#

Intercalate builders.

valueintercalateMap

:: Foldable f
=> TextBuilder
-> a -> TextBuilder
-> f a
-> TextBuilder

#

Intercalate projecting values to builder.

valuepadFromLeft :: Int -> Char -> TextBuilder -> TextBuilder

#

Pad a builder from the left side to the specified length with the specified character.

valuepadFromRight :: Int -> Char -> TextBuilder -> TextBuilder

#

Pad a builder from the right side to the specified length with the specified character.

Textual

valuetext :: Text -> TextBuilder

#

Strict text.

valuelazyText :: Text -> TextBuilder

#

Lazy text.

valuestring :: String -> TextBuilder

#

String.

valueasciiByteString :: ByteString -> TextBuilder

#

ASCII byte string.

It's your responsibility to ensure that the bytes are in proper range, otherwise the produced text will be broken.

valuehexData :: ByteString -> TextBuilder

#

Hexadecimal readable representation of binary data.

Character

valuechar :: Char -> TextBuilder

#

Unicode character.

Low-level character

valueunicodeCodePoint :: Int -> TextBuilder

#

Unicode code point.

valueutf16CodeUnits1 :: Word16 -> TextBuilder

#

Single code-unit UTF-16 character.

valueutf16CodeUnits2 :: Word16 -> Word16 -> TextBuilder

#

Double code-unit UTF-16 character.

valueutf8CodeUnits1 :: Word8 -> TextBuilder

#

Single code-unit UTF-8 character.

valueutf8CodeUnits2 :: Word8 -> Word8 -> TextBuilder

#

Double code-unit UTF-8 character.

valueutf8CodeUnits3 :: Word8 -> Word8 -> Word8 -> TextBuilder

#

Triple code-unit UTF-8 character.

valueutf8CodeUnits4 :: Word8 -> Word8 -> Word8 -> Word8 -> TextBuilder

#

UTF-8 character out of 4 code units.

Integers

Decimal

valuedecimal :: Integral a => a -> TextBuilder

#

Decimal representation of an integral value.

valueunsignedDecimal :: Integral a => a -> TextBuilder

#

Decimal representation of an unsigned integral value.

valuefixedUnsignedDecimal :: Integral a => Int -> a -> TextBuilder

#

valuethousandSeparatedDecimal :: Integral a => Char -> a -> TextBuilder

#

Decimal representation of an integral value with thousands separated by the specified character.

valuethousandSeparatedUnsignedDecimal :: Integral a => Char -> a -> TextBuilder

#

Decimal representation of an unsigned integral value with thousands separated by the specified character.

valuedataSizeInBytesInDecimal :: Integral a => Char -> a -> TextBuilder

#

Data size in decimal notation over amount of bytes.

Binary

valueunsignedBinary :: Integral a => a -> TextBuilder

#

Unsigned binary number.

valueunsignedPaddedBinary :: (Integral a, FiniteBits a) => a -> TextBuilder

#

Unsigned binary number.

valuefiniteBitsUnsignedBinary :: FiniteBits a => a -> TextBuilder

#

A less general but faster alternative to unsignedBinary.

Hexadecimal

valuehexadecimal :: Integral a => a -> TextBuilder

#

Hexadecimal representation of an integral value.

valueunsignedHexadecimal :: Integral a => a -> TextBuilder

#

Unsigned hexadecimal representation of an integral value.

Digits

valuedecimalDigit :: Integral a => a -> TextBuilder

#

Decimal digit.

valuehexadecimalDigit :: Integral a => a -> TextBuilder

#

Hexadecimal digit.

Real

valuefixedDouble

:: Int
Amount of decimals after point.
-> Double
-> TextBuilder

#

Double with a fixed number of decimal places.

valuedoublePercent

:: Int
Amount of decimals after point.
-> Double
-> TextBuilder

#

Double multiplied by 100 with a fixed number of decimal places applied and followed by a percent-sign.

Time

valueutcTimeInIso8601 :: UTCTime -> TextBuilder

#

valueutcTimestampInIso8601

:: Int
Year.
-> Int
Month.
-> Int
Day.
-> Int
Hour.
-> Int
Minute.
-> Int
Second.
-> TextBuilder

#

General template for formatting date values according to the ISO8601 standard. The format is the following:

2021-11-24T12:11:02Z

Integrations with various time-libraries can be easily derived from that.

valueintervalInSeconds :: RealFrac seconds => seconds -> TextBuilder

#

Time interval in seconds. Directly applicable to DiffTime and NominalDiffTime.

Classes

1 declaration

classclass IsomorphicToTextBuilder a where

#

Evidence that there exists an unambiguous way to convert a type to and from TextBuilder.

Unlike conversion classes from other libs this class is lawful. The law is:

fromTextBuilder . toTextBuilder = id

This class does not provide implicit rendering, such as from integer to its decimal representation. There are multiple ways of representing an integer as text (e.g., hexadecimal, binary). The non-ambiguity is further enforced by the presence of the inverse conversion. In the integer case there is no way to read it from a textual form without a possibility of failing (e.g., when the input string cannot be parsed as an integer).

If you're looking for such conversion classes, this library is not a place for them, since there can be infinite amount of flavours of conversions. They are context-dependent and as such should be defined as part of the domain.

Methods

toTextBuilder :: a -> TextBuilder
fromTextBuilder :: TextBuilder -> a

Instances5IsomorphicToTextBuilder

IsomorphicToTextBuilder StringDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicToTextBuilder TextDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicToTextBuilder BuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicToTextBuilder TextDefined in text-builder-dev-0.3.4.2 · TextBuilderDev
IsomorphicToTextBuilder TextBuilderDefined in text-builder-dev-0.3.4.2 · TextBuilderDev