Toml.Pretty

Contents

Description

This module provides human-readable renderers for types used in this package to assist error message production.

The generated Doc values are annotated with DocClass values to assist in producing syntax-highlighted outputs.

To extract a plain String representation, use show.

Synopsis

Types

Pretty-printer document with TOML class attributes to aid in syntax-highlighting.

Annotation used to enable styling pretty-printed TOML

Constructors

TableClass	top-level `[key]` and `[[key]]`
KeyClass	dotted keys, left-hand side of assignments
StringClass	string literals
NumberClass	number literals
DateClass	date and time literals
BoolClass	boolean literals

Instances details

Read DocClass Source #
Instance details Defined in Toml.Pretty Methods readsPrec :: Int -> ReadS DocClass # readList :: ReadS [DocClass] # readPrec :: ReadPrec DocClass # readListPrec :: ReadPrec [DocClass] #
Show DocClass Source #
Instance details Defined in Toml.Pretty Methods showsPrec :: Int -> DocClass -> ShowS # show :: DocClass -> String # showList :: [DocClass] -> ShowS #
Eq DocClass Source #
Instance details Defined in Toml.Pretty Methods (==) :: DocClass -> DocClass -> Bool # (/=) :: DocClass -> DocClass -> Bool #
Ord DocClass Source #
Instance details Defined in Toml.Pretty Methods compare :: DocClass -> DocClass -> Ordering # (<) :: DocClass -> DocClass -> Bool # (<=) :: DocClass -> DocClass -> Bool # (>) :: DocClass -> DocClass -> Bool # (>=) :: DocClass -> DocClass -> Bool # max :: DocClass -> DocClass -> DocClass # min :: DocClass -> DocClass -> DocClass #

semantic values

Render a complete TOML document using top-level table and array of table sections where appropriate.

Render a value suitable for assignment on the right-hand side of an equals sign. This value will always occupy a single line.

Render token for human-readable error messages.

Pretty-print a section heading. The result is annotated as a TableClass.

Renders a simple-key using quotes where necessary.

Renders a dotted-key using quotes where necessary and annotated as a KeyClass.