Safe Haskell | None |
---|---|
Language | Haskell2010 |
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
- newtype YamlBuilder = YamlBuilder {
- unYamlBuilder :: [Event] -> [Event]
- class ToYaml a where
- toYaml :: a -> YamlBuilder
- mapping :: [(Text, YamlBuilder)] -> YamlBuilder
- namedMapping :: Text -> [(Text, YamlBuilder)] -> YamlBuilder
- maybeNamedMapping :: Maybe Text -> [(Text, YamlBuilder)] -> YamlBuilder
- array :: [YamlBuilder] -> YamlBuilder
- namedArray :: Text -> [YamlBuilder] -> YamlBuilder
- maybeNamedArray :: Maybe Text -> [YamlBuilder] -> YamlBuilder
- string :: Text -> YamlBuilder
- namedString :: Text -> Text -> YamlBuilder
- maybeNamedString :: Maybe Text -> Text -> YamlBuilder
- bool :: Bool -> YamlBuilder
- namedBool :: Text -> Bool -> YamlBuilder
- maybeNamedBool :: Maybe Text -> Bool -> YamlBuilder
- null :: YamlBuilder
- namedNull :: Text -> YamlBuilder
- maybeNamedNull :: Maybe Text -> YamlBuilder
- scientific :: Scientific -> YamlBuilder
- namedScientific :: Text -> Scientific -> YamlBuilder
- maybeNamedScientific :: Maybe Text -> Scientific -> YamlBuilder
- alias :: Text -> YamlBuilder
- number :: Scientific -> YamlBuilder
- toByteString :: ToYaml a => a -> ByteString
- toByteStringWith :: ToYaml a => FormatOptions -> a -> ByteString
- writeYamlFile :: ToYaml a => FilePath -> a -> IO ()
- writeYamlFileWith :: ToYaml a => FormatOptions -> FilePath -> a -> IO ()
- (.=) :: ToYaml a => Text -> a -> (Text, YamlBuilder)
- data FormatOptions
- setWidth :: Maybe Int -> FormatOptions -> FormatOptions
Documentation
newtype YamlBuilder #
Constructors
YamlBuilder | |
Fields
|
Instances
ToYaml YamlBuilder # | |
Defined in Data.Yaml.Builder Methods toYaml :: YamlBuilder -> YamlBuilder # |
Methods
toYaml :: a -> YamlBuilder #
Instances
ToYaml Int # | |
Defined in Data.Yaml.Builder Methods toYaml :: Int -> YamlBuilder # | |
ToYaml Text # | |
Defined in Data.Yaml.Builder Methods toYaml :: Text -> YamlBuilder # | |
ToYaml YamlBuilder # | |
Defined in Data.Yaml.Builder Methods toYaml :: YamlBuilder -> YamlBuilder # | |
ToYaml a => ToYaml [(Text, a)] # | |
Defined in Data.Yaml.Builder Methods toYaml :: [(Text, a)] -> YamlBuilder # | |
ToYaml a => ToYaml [a] # | |
Defined in Data.Yaml.Builder Methods toYaml :: [a] -> YamlBuilder # |
mapping :: [(Text, YamlBuilder)] -> YamlBuilder #
namedMapping :: Text -> [(Text, YamlBuilder)] -> YamlBuilder #
Since: 0.11.0
maybeNamedMapping :: Maybe Text -> [(Text, YamlBuilder)] -> YamlBuilder #
Since: 0.11.0
array :: [YamlBuilder] -> YamlBuilder #
namedArray :: Text -> [YamlBuilder] -> YamlBuilder #
Since: 0.11.0
maybeNamedArray :: Maybe Text -> [YamlBuilder] -> YamlBuilder #
Since: 0.11.0
string :: Text -> YamlBuilder #
namedString :: Text -> Text -> YamlBuilder #
Since: 0.11.0
maybeNamedString :: Maybe Text -> Text -> YamlBuilder #
Since: 0.11.0
bool :: Bool -> YamlBuilder #
namedBool :: Text -> Bool -> YamlBuilder #
Since: 0.11.0
maybeNamedBool :: Maybe Text -> Bool -> YamlBuilder #
Since: 0.11.0
null :: YamlBuilder #
namedNull :: Text -> YamlBuilder #
Since: 0.11.0
maybeNamedNull :: Maybe Text -> YamlBuilder #
Since: 0.11.0
scientific :: Scientific -> YamlBuilder #
namedScientific :: Text -> Scientific -> YamlBuilder #
Since: 0.11.0
maybeNamedScientific :: Maybe Text -> Scientific -> YamlBuilder #
Since: 0.11.0
alias :: Text -> YamlBuilder #
Since: 0.11.0
number :: Scientific -> YamlBuilder #
Deprecated: Use scientific
toByteString :: ToYaml a => a -> ByteString #
toByteStringWith :: ToYaml a => FormatOptions -> a -> ByteString #
Since: 0.10.2.0
writeYamlFile :: ToYaml a => FilePath -> a -> IO () #
writeYamlFileWith :: ToYaml a => FormatOptions -> FilePath -> a -> IO () #
Since: 0.10.2.0
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