Cardano.Api.Pretty

Alter the document’s annotations.

This instance makes Doc more flexible (because it can be used in Functor-polymorphic values), but fmap is much less readable compared to using reAnnotate in code that only works for Doc anyway. Consider using the latter when the type does not matter.

(show doc) prettyprints document doc with defaultLayoutOptions, ignoring all annotations.

>>> pretty ("hello\nworld")helloworld

This instance uses the Pretty Text instance, and uses the same newline to line conversion.

Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing.

>>> pretty ([] :: [Void])[]

Instead of (pretty '\n'), consider using line as a more readable alternative.

>>> pretty 'f' <> pretty 'o' <> pretty 'o'foo>>> pretty ("string" :: String)string

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)helloworld

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))hello world

Manually use hardline if you definitely want newlines.

(lazy Text instance, identical to the strict version)

>>> pretty ()()

The argument is not used:

>>> pretty (error "Strict?" :: ())()

Ignore Nothings, print Just contents.

>>> pretty (Just True)True>>> braces (pretty (Nothing :: Maybe Bool)){}

>>> pretty [Just 1, Nothing, Just 3, Nothing][1, 3]

Performs replacement on invalid scalar values:

>>> :set -XOverloadedLists>>> ['\55555'] :: Text"\65533"

This instance preserves data abstraction at the cost of inefficiency. We omit reflection services for the sake of data abstraction.

This instance was created by copying the updated behavior of Data.Set.Set and Data.Map.Data.Map.Map. If you feel a mistake has been made, please feel free to submit improvements.

The original discussion is archived here: could we get a Data instance for Data.Text.Text?

The followup discussion that changed the behavior of Set and Data.Map.Map is archived here: Proposal: Allow gunfold for Data.Map, ...

Performs replacement on invalid scalar values:

>>> :set -XOverloadedStrings>>> "\55555" :: Text"\65533"

Beware: stimes will crash if the given number does not fit into an Int.

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)helloworld

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))hello world

Manually use hardline if you definitely want newlines.

Assumes UTF-8 encoding. Fails on invalid byte sequences.

Uses UTF-8 encoding.

Automatically converts all newlines to line.

>>> prettyBy () ("hello\nworld" :: Strict.Text)helloworld

Makes a STM action be run to get the content of a region.

Any change to the values that action reads will result in an immediate refresh of the display.