@@ -78,17 +78,19 @@ instance ToYaml Int where
7878 toYaml i = YamlBuilder (EventScalar (S8.pack $ show i) NoTag PlainNoTag Nothing:)
7979
8080-- |
81−-- @since 0.11.0
81+-- @since 0.10.3.0
8282maybeNamedMapping :: Maybe Text -> [(Text, YamlBuilder)] -> YamlBuilder
8383maybeNamedMapping anchor pairs = maybeNamedMappingComplex anchor complexPairs
8484 where
8585 complexPairs = map (\(k, v) -> (string k, v)) pairs
8686
87+-- |
88+-- @since 0.8.7
8789mapping :: [(Text, YamlBuilder)] -> YamlBuilder
8890mapping = maybeNamedMapping Nothing
8991
9092-- |
91−-- @since 0.11.0
93+-- @since 0.10.3.0
9294namedMapping :: Text -> [(Text, YamlBuilder)] -> YamlBuilder
9395namedMapping name = maybeNamedMapping $ Just name
9496
@@ -111,81 +113,93 @@ namedMappingComplex :: Text -> [(YamlBuilder, YamlBuilder)] -> YamlBuilder
111113namedMappingComplex name = maybeNamedMappingComplex $ Just name
112114
113115-- |
114−-- @since 0.11.0
116+-- @since 0.10.3.0
115117maybeNamedArray :: Maybe Text -> [YamlBuilder] -> YamlBuilder
116118maybeNamedArray anchor bs =
117119 YamlBuilder $ (EventSequenceStart NoTag AnySequence (unpack <$> anchor):) . flip (foldr go) bs . (EventSequenceEnd:)
118120 where
119121 go (YamlBuilder b) = b
120122
123+-- |
124+-- @since 0.8.7
121125array :: [YamlBuilder] -> YamlBuilder
122126array = maybeNamedArray Nothing
123127
124128-- |
125−-- @since 0.11.0
129+-- @since 0.10.3.0
126130namedArray :: Text -> [YamlBuilder] -> YamlBuilder
127131namedArray name = maybeNamedArray $ Just name
128132
129133-- |
130−-- @since 0.11.0
134+-- @since 0.10.3.0
131135maybeNamedString :: Maybe Text -> Text -> YamlBuilder
132136maybeNamedString anchor s = YamlBuilder (stringScalar defaultStringStyle anchor s :)
133137
138+-- |
139+-- @since 0.8.7
134140string :: Text -> YamlBuilder
135141string = maybeNamedString Nothing
136142
137143-- |
138−-- @since 0.11.0
144+-- @since 0.10.3.0
139145namedString :: Text -> Text -> YamlBuilder
140146namedString name = maybeNamedString $ Just name
141147
142148-- Use aeson's implementation which gets rid of annoying decimal points
143149-- |
144−-- @since 0.11.0
150+-- @since 0.10.3.0
145151maybeNamedScientific :: Maybe Text -> Scientific -> YamlBuilder
146152maybeNamedScientific anchor n = YamlBuilder (EventScalar (TE.encodeUtf8 $ TL.toStrict $ toLazyText $ encodeToTextBuilder (Number n)) NoTag PlainNoTag (unpack <$> anchor) :)
147153
154+-- |
155+-- @since 0.8.13
148156scientific :: Scientific -> YamlBuilder
149157scientific = maybeNamedScientific Nothing
150158
151159-- |
152−-- @since 0.11.0
160+-- @since 0.10.3.0
153161namedScientific :: Text -> Scientific -> YamlBuilder
154162namedScientific name = maybeNamedScientific $ Just name
155163
164+-- |
165+-- @since 0.8.13
156166{-# DEPRECATED number "Use scientific" #-}
157167number :: Scientific -> YamlBuilder
158168number = scientific
159169
160170-- |
161−-- @since 0.11.0
171+-- @since 0.10.3.0
162172maybeNamedBool :: Maybe Text -> Bool -> YamlBuilder
163173maybeNamedBool anchor True = YamlBuilder (EventScalar "true" NoTag PlainNoTag (unpack <$> anchor) :)
164174maybeNamedBool anchor False = YamlBuilder (EventScalar "false" NoTag PlainNoTag (unpack <$> anchor) :)
165175
176+-- |
177+-- @since 0.8.13
166178bool :: Bool -> YamlBuilder
167179bool = maybeNamedBool Nothing
168180
169181-- |
170−-- @since 0.11.0
182+-- @since 0.10.3.0
171183namedBool :: Text -> Bool -> YamlBuilder
172184namedBool name = maybeNamedBool $ Just name
173185
174186-- |
175−-- @since 0.11.0
187+-- @since 0.10.3.0
176188maybeNamedNull :: Maybe Text -> YamlBuilder
177189maybeNamedNull anchor = YamlBuilder (EventScalar "null" NoTag PlainNoTag (unpack <$> anchor) :)
178190
191+-- |
192+-- @since 0.8.13
179193null :: YamlBuilder
180194null = maybeNamedNull Nothing
181195
182196-- |
183−-- @since 0.11.0
197+-- @since 0.10.3.0
184198namedNull :: Text -> YamlBuilder
185199namedNull name = maybeNamedNull $ Just name
186200
187201-- |
188−-- @since 0.11.0
202+-- @since 0.10.3.0
189203alias :: Text -> YamlBuilder
190204alias anchor = YamlBuilder (EventAlias (unpack anchor) :)
191205
@@ -196,6 +210,8 @@ toEvents (YamlBuilder front) =
196210toSource :: (Monad m, ToYaml a) => a -> ConduitM i Event m ()
197211toSource = mapM_ yield . toEvents . toYaml
198212
213+-- |
214+-- @since 0.8.7
199215toByteString :: ToYaml a => a -> ByteString
200216toByteString = toByteStringWith defaultFormatOptions
201217