Copyright	(c) 2018-2022 Kowainik
License	MPL-2.0
Maintainer	Kowainik <xrom.xkov@gmail.com>
Stability	Stable
Portability	Portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Toml.Type.Printer

Description

Contains functions for pretty printing toml types.

Since: 0.0.0

Synopsis

data PrintOptions = PrintOptions {
- printOptionsSorting :: !(Maybe (Key -> Key -> Ordering))
- printOptionsIndent :: !Int
- printOptionsLines :: !Lines
}
data Lines
- = OneLine
- | MultiLine
defaultOptions :: PrintOptions
pretty :: TOML -> Text
prettyOptions :: PrintOptions -> TOML -> Text
prettyKey :: Key -> Text

Documentation

data PrintOptions Source #

Configures the pretty printer.

Since: 0.5.0

Constructors

PrintOptions
Fields printOptionsSorting :: !(Maybe (Key -> Key -> Ordering)) How table keys should be sorted, if at all. Since: 1.1.0.0 printOptionsIndent :: !Int Number of spaces by which to indent. Since: 1.1.0.0 printOptionsLines :: !Lines How to print Array. OneLine: foo = [a, b] MultiLine: foo = [ a , b ] Default is `OneLine`.

data Lines Source #

Constructors

OneLine
MultiLine

defaultOptions :: PrintOptions Source #

Default printing options.

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

Since: 0.5.0

pretty :: TOML -> Text Source #

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"

Since: 0.0.0

prettyOptions :: PrintOptions -> TOML -> Text Source #

Converts TOML type into Text using provided PrintOptions

Since: 0.5.0

prettyKey :: Key -> Text Source #

Converts a key to text

Since: 0.0.0