Toml.Printer

Contains functions for pretty printing toml types.

Documentation

data PrintOptions

Configures the pretty printer.

Constructors

PrintOptions

Fields

• shouldSort :: Bool

  should table keys be sorted or not

• indent :: Int

  indentation size

Instances

Show PrintOptions

Defined in Toml.Printer

Methods

showsPrec :: Int -> PrintOptions -> ShowS

show :: PrintOptions -> String

showList :: [PrintOptions] -> ShowS

defaultOptions :: PrintOptions

Default printing options.

1. Sorts all keys and tables by name.
2. Indents with 2 spaces.

pretty :: TOML -> Text

Converts TOML type into Text (using defaultOptions).

For example, this

TOML
    { tomlPairs  = HashMap.fromList
          [("title", AnyValue $ Text "TOML example")]
    , tomlTables = PrefixTree.fromList
          [( "example" <| "owner"
           , mempty
                 { tomlPairs  = HashMap.fromList
                       [("name", AnyValue $ Text Kowainik)]
                 }
           )]
    , tomlTableArrays = mempty
    }

will be translated to this

title = "TOML Example"

[example.owner]
  name = "Kowainik"

prettyOptions :: PrintOptions -> TOML -> Text

Converts TOML type into Text using provided PrintOptions

prettyKey :: Key -> Text

Converts a key to text