TextBuilderDev · text-builder-dev-0.4.0.1

datadata TextBuilder

#

Composable specification of how to efficiently construct strict Text.

Provides instances of Semigroup and Monoid, which have complexity of O(1).

Instances7Eq, Show, IsString, Semigroup, Monoid, Arbitrary, …

Eq TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
Show TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
IsString TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
Semigroup TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
Monoid TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
Arbitrary TextBuilderDefined in text-builder-core-0.1.1.3 · TextBuilderCore
Isomorphic TextBuilderDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Isomorphic

Accessors

3 declarations

valuetoText :: TextBuilder -> Text

#

Execute the builder producing a strict text.

valuetoString :: TextBuilder -> String

#

Convert builder to string.

valueisEmpty :: TextBuilder -> Bool

#

Check whether the builder is empty.

Constructors

0 declarations

Transformations

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 to memcopy.

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

#

Intercalate builders.

Example1 expression

>>> intercalate ", " ["a", "b", "c"]"a, b, c"

Example1 expression

>>> intercalate ", " ["a"]"a"

Example1 expression

>>> intercalate ", " []""

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.

Example1 expression

>>> padFromLeft 5 '0' "123""00123"

Example1 expression

>>> padFromLeft 5 '0' "123456""123456"

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

#

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

Example1 expression

>>> padFromRight 5 ' ' "123""123  "

Example1 expression

>>> padFromRight 5 ' ' "123456""123456"

Textual

valuetext :: Text -> TextBuilder

#

Strict text.

valuelazyText :: Text -> TextBuilder

#

Lazy text.

valuestring :: String -> TextBuilder

#

Construct from a list of characters.

valueunsafeUtf8ByteString :: ByteString -> TextBuilder

#

UTF-8 bytestring. You can use it for converting ASCII values as well.

Warning: It's your responsibility to ensure that the bytestring is properly encoded.

Example1 expression

>>> unsafeUtf8ByteString "abc""abc"

Example2 expressions

>>> import Data.Text.Encoding (encodeUtf8)>>> unsafeUtf8ByteString (encodeUtf8 "фывапролдж") == "фывапролдж"True

Character

valuechar :: Char -> TextBuilder

#

Unicode character.

valueunicodeCodepoint :: Int -> TextBuilder

#

Safe Unicode codepoint with invalid values replaced by the � char (codepoint 0xfffd), which is the same as what Data.Text.pack does.

Data

valuebyteStringHexEncoding :: ByteString -> TextBuilder

#

Hexadecimal readable representation of binary data.

Example1 expression

>>> byteStringHexEncoding "Hello""4865 6c6c 6f"

Integers

Decimal

valuedecimal :: Integral a => a -> TextBuilder

#

Signed decimal representation of an integer.

Example1 expression

>>> decimal 123456"123456"

Example1 expression

>>> decimal (-123456)"-123456"

Example1 expression

>>> decimal 0"0"

Example1 expression

>>> decimal (-2 :: Int8)"-2"

Example1 expression

>>> decimal (-128 :: Int8)"-128"

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

#

Fixed-length decimal without sign. Padded with zeros or trimmed depending on whether it's shorter or longer than specified.

Example1 expression

>>> fixedLengthDecimal 5 123"00123"

Example1 expression

>>> fixedLengthDecimal 5 123456"23456"

Example1 expression

>>> fixedLengthDecimal 5 (-123456)"23456"

Example1 expression

>>> fixedLengthDecimal 7 (-123456)"0123456"

Example1 expression

>>> fixedLengthDecimal 0 123""

Example1 expression

>>> fixedLengthDecimal (-2) 123""

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

#

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

Example1 expression

>>> thousandSeparatedDecimal ',' 1234567890"1,234,567,890"

Example1 expression

>>> thousandSeparatedDecimal ' ' (-1234567890)"-1 234 567 890"

Binary

valuebinary :: FiniteBits a => a -> TextBuilder

#

Two's complement binary representation of a value.

Bits of a statically sized value padded from the left according to the size. If it's a negatable integer, the sign is reflected in the bits.

Example1 expression

>>> binary @Int8 0"00000000"

Example1 expression

>>> binary @Int8 4"00000100"

Example1 expression

>>> binary @Int8 (-1)"11111111"

Example1 expression

>>> binary @Word8 255"11111111"

Example1 expression

>>> binary @Int16 4"0000000000000100"

Example1 expression

>>> binary @Int16 (-4)"1111111111111100"

valueprefixedBinary :: FiniteBits a => a -> TextBuilder

#

Same as binary, but with the "0b" prefix.

Example1 expression

>>> prefixedBinary @Int8 0"0b00000000"

Octal

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

#

Octal representation of an integer.

Example1 expression

>>> octal @Int32 123456"00000361100"

Example1 expression

>>> octal @Int32 (-123456)"77777416700"

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

#

Same as octal, but with the "0o" prefix.

Example1 expression

>>> prefixedOctal @Int8 0"0o000"

Hexadecimal

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

#

Integer in hexadecimal notation with a fixed number of digits determined by the size of the type.

Example1 expression

>>> hexadecimal @Int8 0"00"

Example1 expression

>>> hexadecimal @Int8 4"04"

Example1 expression

>>> hexadecimal @Int8 (-128)"80"

Example1 expression

>>> hexadecimal @Int8 (-1)"ff"

Example1 expression

>>> hexadecimal @Word8 255"ff"

Example1 expression

>>> hexadecimal @Int32 123456"0001e240"

Example1 expression

>>> hexadecimal @Int32 (-123456)"fffe1dc0"

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

#

Same as hexadecimal, but with the "0x" prefix.

Example1 expression

>>> prefixedHexadecimal @Int8 0"0x00"

Real

valuedoubleFixedPoint

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

#

Double with a fixed number of decimal places.

Example1 expression

>>> doubleFixedPoint 4 0.123456"0.1235"

Example1 expression

>>> doubleFixedPoint 2 2.1"2.10"

Example1 expression

>>> doubleFixedPoint (-2) 2.1"2"

Example1 expression

>>> doubleFixedPoint 2 (-2.1)"-2.10"

Example1 expression

>>> doubleFixedPoint 2 0"0.00"

valuedoubleFixedPointPercent

:: 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.

Example1 expression

>>> doubleFixedPointPercent 3 0.123456"12.346%"

Example1 expression

>>> doubleFixedPointPercent 0 2"200%"

Example1 expression

>>> doubleFixedPointPercent 0 (-2)"-200%"

Time

valueutcTimeIso8601Timestamp :: UTCTime -> TextBuilder

#

UTC time in ISO8601 format.

Example1 expression

>>> utcTimeIso8601Timestamp (read "2021-11-24 12:11:02 UTC")"2021-11-24T12:11:02Z"

valuerealFracDdHhMmSsInterval :: RealFrac seconds => seconds -> TextBuilder

#

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

The format is the following:

DD:HH:MM:SS

Example1 expression

>>> realFracDdHhMmSsInterval @Double 59"00:00:00:59"

Example1 expression

>>> realFracDdHhMmSsInterval @Double 90"00:00:01:30"

Example1 expression

>>> realFracDdHhMmSsInterval @Double 86401"01:00:00:01"

Example1 expression

>>> realFracDdHhMmSsInterval @Double (356 * 86400)"356:00:00:00"

valuediffTimeSeconds :: DiffTime -> TextBuilder

#

DiffTime in a compact decimal format based on picoseconds.

valuepicoseconds :: Integer -> TextBuilder

#

Amount of picoseconds represented in a compact decimal format using suffixes.

E.g., the following is 1_230_000_000 picoseconds or 1.23 milliseconds or 1230 microseconds:

1230us

Other

valueapproximateDataSize :: Integral a => a -> TextBuilder

#

Data size in decimal notation over amount of bytes.

Example1 expression

>>> approximateDataSize 999"999B"

Example1 expression

>>> approximateDataSize 9999"9.9kB"

Example1 expression

>>> approximateDataSize (-9999)"-9.9kB"

Example1 expression

>>> approximateDataSize 1234567890"1.2GB"

Example1 expression

>>> approximateDataSize 10000000000000000000000000000000023"10,000,000,000YB"

Classes

1 declaration

classclass Isomorphic a where

#

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

The laws are:

```
from . to = id
```
```
to . from = 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).

Methods

from :: a -> TextBuilder
Project the type into TextBuilder.
to :: TextBuilder -> a
Embed TextBuilder into the type.

Instances5Isomorphic

Isomorphic TextDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Isomorphic
Isomorphic BuilderDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Isomorphic
Isomorphic TextDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Isomorphic
Isomorphic StrictTextBuilderDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Domains.StrictTextBuilder · orphan
Isomorphic TextBuilderDefined in text-builder-dev-0.4.0.1 · TextBuilderDev.Isomorphic