yaml-0.11.5.0: Support for parsing and rendering YAML documents.

Safe HaskellNone
LanguageHaskell2010

Data.Yaml.Builder

Description

NOTE: This module is a highly experimental preview release. It may change drastically, or be entirely removed, in a future release.

Synopsis

Documentation

newtype YamlBuilder Source #

Constructors

YamlBuilder 

Fields

Instances
ToYaml YamlBuilder Source # 
Instance details

Defined in Data.Yaml.Builder

class ToYaml a where Source #

Methods

toYaml :: a -> YamlBuilder Source #

Instances
ToYaml Bool Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml Double Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml Int Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml Scientific Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml Text Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml String Source # 
Instance details

Defined in Data.Yaml.Builder

ToYaml YamlBuilder Source # 
Instance details

Defined in Data.Yaml.Builder

(ToYaml a, ToYaml b) => ToYaml [(a, b)] Source # 
Instance details

Defined in Data.Yaml.Builder

Methods

toYaml :: [(a, b)] -> YamlBuilder Source #

ToYaml a => ToYaml [a] Source # 
Instance details

Defined in Data.Yaml.Builder

Methods

toYaml :: [a] -> YamlBuilder Source #

ToYaml a => ToYaml (Maybe a) Source # 
Instance details

Defined in Data.Yaml.Builder

mapping :: [(Text, YamlBuilder)] -> YamlBuilder Source #

Since: 0.8.7

namedMapping :: Text -> [(Text, YamlBuilder)] -> YamlBuilder Source #

Since: 0.10.3.0

array :: [YamlBuilder] -> YamlBuilder Source #

Since: 0.8.7

namedArray :: Text -> [YamlBuilder] -> YamlBuilder Source #

Since: 0.10.3.0

string :: Text -> YamlBuilder Source #

Since: 0.8.7

namedString :: Text -> Text -> YamlBuilder Source #

Since: 0.10.3.0

bool :: Bool -> YamlBuilder Source #

Since: 0.8.13

namedBool :: Text -> Bool -> YamlBuilder Source #

Since: 0.10.3.0

maybeNamedBool :: Maybe Text -> Bool -> YamlBuilder Source #

Since: 0.10.3.0

null :: YamlBuilder Source #

Since: 0.8.13

namedNull :: Text -> YamlBuilder Source #

Since: 0.10.3.0

alias :: Text -> YamlBuilder Source #

Since: 0.10.3.0

number :: Scientific -> YamlBuilder Source #

Deprecated: Use scientific

Since: 0.8.13

toByteString :: ToYaml a => a -> ByteString Source #

Since: 0.8.7

toByteStringWith :: ToYaml a => FormatOptions -> a -> ByteString Source #

Since: 0.10.2.0

writeYamlFile :: ToYaml a => FilePath -> a -> IO () Source #

writeYamlFileWith :: ToYaml a => FormatOptions -> FilePath -> a -> IO () Source #

Since: 0.10.2.0

(.=) :: ToYaml a => Text -> a -> (Text, YamlBuilder) Source #

data FormatOptions #

Contains options relating to the formatting (indendation, width) of the YAML output.

Since: libyaml-0.10.2.0

setWidth :: Maybe Int -> FormatOptions -> FormatOptions #

Set the maximum number of columns in the YAML output, or Nothing for infinite. By default, the limit is 80 characters.

Since: libyaml-0.10.2.0