haddock-improvements/Data-Aeson-Encode.html at master · haskellbr/haddock-improvements · GitHub

1
2
3
4
5
6
7
8
9
10
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Aeson.Encode</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Aeson-Encode.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Aeson-Encode.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">aeson-0.10.0.0: Fast JSON parsing and encoding</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) 2012-2015 Bryan O'Sullivan
              (c) 2011 MailRank, Inc.</td></tr><tr><th>License</th><td>Apache</td></tr><tr><th>Maintainer</th><td>Bryan O'Sullivan &lt;bos@serpentine.com&gt;</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Data.Aeson.Encode</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Encoding to Builders</a></li><li><a href="#g:2">Deprecated</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Efficiently serialize a JSON value.</p><p>Most frequently, you'll probably want to encode straight to UTF-8
 (the standard JSON encoding) using <code><a href="Data-Aeson-Encode.html#v:encode">encode</a></code>.</p><p>You can use the conversions to <code><a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a></code>s when embedding JSON messages as
 parts of a protocol.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:encode">encode</a> :: <a href="Data-Aeson-Types.html#t:ToJSON">ToJSON</a> a =&gt; a -&gt; <a href="../bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:encodeToBuilder">encodeToBuilder</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../bytestring-0.10.6.0/Data-ByteString-Builder.html#t:Builder">Builder</a></li><li class="src short"><a href="#v:encodeToTextBuilder">encodeToTextBuilder</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a></li><li class="src short"><a href="#v:fromValue">fromValue</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:encode" class="def">encode</a> :: <a href="Data-Aeson-Types.html#t:ToJSON">ToJSON</a> a =&gt; a -&gt; <a href="../bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/Data-Aeson-Encode-Functions.html#encode" class="link">Source</a></p><div class="doc"><p>Efficiently serialize a JSON value as a lazy <code><a href="../bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></code>.</p><p>This is implemented in terms of the <code><a href="Data-Aeson-Types.html#t:ToJSON">ToJSON</a></code> class's <code><a href="Data-Aeson-Types.html#v:toEncoding">toEncoding</a></code> method.</p></div></div><h1 id="g:1">Encoding to Builders</h1><div class="top"><p class="src"><a name="v:encodeToBuilder" class="def">encodeToBuilder</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../bytestring-0.10.6.0/Data-ByteString-Builder.html#t:Builder">Builder</a> <a href="src/Data-Aeson-Encode-Builder.html#encodeToBuilder" class="link">Source</a></p><div class="doc"><p>Encode a JSON value to a <a href="../bytestring-0.10.6.0/Data-ByteString.html">Data.ByteString</a> <code><a href="../bytestring-0.10.6.0/Data-ByteString-Builder.html#t:Builder">Builder</a></code>.</p><p>Use this function if you are encoding over the wire, or need to
 prepend or append further bytes to the encoded JSON value.</p></div></div><div class="top"><p class="src"><a name="v:encodeToTextBuilder" class="def">encodeToTextBuilder</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a> <a href="src/Data-Aeson-Encode.html#encodeToTextBuilder" class="link">Source</a></p><div class="doc"><p>Encode a JSON <code><a href="Data-Aeson-Types.html#t:Value">Value</a></code> to a <a href="../text-1.2.1.3/Data-Text.html">Data.Text</a> <code><a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a></code>, which can be
 embedded efficiently in a text-based protocol.</p><p>If you are going to immediately encode straight to a
 <code><a href="L.html#v:ByteString">ByteString</a></code>, it is more efficient to use <code><a href="Data-Aeson-Encode.html#v:encodeToBuilder">encodeToBuilder</a></code>
 instead.</p></div></div><h1 id="g:2">Deprecated</h1><div class="top"><p class="src"><a name="v:fromValue" class="def">fromValue</a> :: <a href="Data-Aeson-Types.html#t:Value">Value</a> -&gt; <a href="../text-1.2.1.3/Data-Text-Lazy-Builder.html#t:Builder">Builder</a> <a href="src/Data-Aeson-Encode.html#fromValue" class="link">Source</a></p><div class="doc"><div class="warning"><p>Deprecated: Use <code><a href="Data-Aeson-Encode.html#v:encodeToTextBuilder">encodeToTextBuilder</a></code> instead</p></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>