<!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>Codec.Binary.QuotedPrintable</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_Codec-Binary-QuotedPrintable.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Codec-Binary-QuotedPrintable.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">dataenc-0.14: Data encoding library</p></div><div id="content"><div id="module-header"><p class="caption">Codec.Binary.QuotedPrintable</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Implementation of Quoted-Printable based on RFC 2045
(<a href="http://tools.ietf.org/html/rfc2045">http://tools.ietf.org/html/rfc2045</a>).
</p><p>This encoding encodes _everything_ that is passed in, it will not try to
guess the native line ending for your architecture. In other words, if you
are using this to encode text you need to split it into separate lines
before encoding and chopping it up.
</p><p>Further documentation and information can be found at
<a href="http://www.haskell.org/haskellwiki/Library/Data_encoding">http://www.haskell.org/haskellwiki/Library/Data_encoding</a>.
</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"><span class="keyword">data</span> <a href="#t:EncIncData">EncIncData</a> <ul class="subs"><li>= <a href="#v:EChunk">EChunk</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] </li><li>| <a href="#v:EDone">EDone</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:EncIncRes">EncIncRes</a> i<ul class="subs"><li>= <a href="#v:EPart">EPart</a> i (<a href="Codec-Binary-QuotedPrintable.html#t:EncIncData">EncIncData</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:EncIncRes">EncIncRes</a> i) </li><li>| <a href="#v:EFinal">EFinal</a> i </li></ul></li><li class="src short"><a href="#v:encodeInc">encodeInc</a> :: <a href="Codec-Binary-QuotedPrintable.html#t:EncIncData">EncIncData</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:EncIncRes">EncIncRes</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:encode">encode</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:DecIncData">DecIncData</a> i<ul class="subs"><li>= <a href="#v:DChunk">DChunk</a> i </li><li>| <a href="#v:DDone">DDone</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:DecIncRes">DecIncRes</a> i<ul class="subs"><li>= <a href="#v:DPart">DPart</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] (<a href="Codec-Binary-QuotedPrintable.html#t:DecIncData">DecIncData</a> i -> <a href="Codec-Binary-QuotedPrintable.html#t:DecIncRes">DecIncRes</a> i) </li><li>| <a href="#v:DFinal">DFinal</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] i </li><li>| <a href="#v:DFail">DFail</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] i </li></ul></li><li class="src short"><a href="#v:decodeInc">decodeInc</a> :: <a href="Codec-Binary-QuotedPrintable.html#t:DecIncData">DecIncData</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:DecIncRes">DecIncRes</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:decode">decode</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>]</li><li class="src short"><a href="#v:chop">chop</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:unchop">unchop</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:EncIncData" class="def">EncIncData</a> <a href="src/Codec-Binary-Util.html#EncIncData" class="link">Source</a></p><div class="doc"><p>Data type for the incremental encoding functions.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:EChunk" class="def">EChunk</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>]</td><td class="doc"><p>a chunk of data to be encoded
</p></td></tr><tr><td class="src"><a name="v:EDone" class="def">EDone</a></td><td class="doc"><p>the signal to the encoder that the stream of data is ending
</p></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:EncIncRes" class="def">EncIncRes</a> i <a href="src/Codec-Binary-Util.html#EncIncRes" class="link">Source</a></p><div class="doc"><p>Data type for the result of calling the incremental encoding functions.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:EPart" class="def">EPart</a> i (<a href="Codec-Binary-QuotedPrintable.html#t:EncIncData">EncIncData</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:EncIncRes">EncIncRes</a> i)</td><td class="doc"><p>a partial result together with the continuation to use for further encoding
</p></td></tr><tr><td class="src"><a name="v:EFinal" class="def">EFinal</a> i</td><td class="doc"><p>the final result of encoding (the response to <code><a href="Codec-Binary-QuotedPrintable.html#v:EDone">EDone</a></code>)
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:encodeInc" class="def">encodeInc</a> :: <a href="Codec-Binary-QuotedPrintable.html#t:EncIncData">EncIncData</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:EncIncRes">EncIncRes</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Codec-Binary-QuotedPrintable.html#encodeInc" class="link">Source</a></p><div class="doc"><p>Incremental encoder function.
</p></div></div><div class="top"><p class="src"><a name="v:encode" class="def">encode</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Codec-Binary-QuotedPrintable.html#encode" class="link">Source</a></p><div class="doc"><p>Encode data.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DecIncData" class="def">DecIncData</a> i <a href="src/Codec-Binary-Util.html#DecIncData" class="link">Source</a></p><div class="doc"><p>Data type for the incremental decoding functions.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DChunk" class="def">DChunk</a> i</td><td class="doc"><p>a chunk of data to be decoded
</p></td></tr><tr><td class="src"><a name="v:DDone" class="def">DDone</a></td><td class="doc"><p>the signal to the decoder that the stream of data is ending
</p></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DecIncRes" class="def">DecIncRes</a> i <a href="src/Codec-Binary-Util.html#DecIncRes" class="link">Source</a></p><div class="doc"><p>Data type for the result of calling the incremental encoding functions.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DPart" class="def">DPart</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] (<a href="Codec-Binary-QuotedPrintable.html#t:DecIncData">DecIncData</a> i -> <a href="Codec-Binary-QuotedPrintable.html#t:DecIncRes">DecIncRes</a> i)</td><td class="doc"><p>a partial result together with the continuation to user for further decoding
</p></td></tr><tr><td class="src"><a name="v:DFinal" class="def">DFinal</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] i</td><td class="doc"><p>the final result of decoding (the response to <code><a href="Codec-Binary-QuotedPrintable.html#v:DDone">DDone</a></code>)
</p></td></tr><tr><td class="src"><a name="v:DFail" class="def">DFail</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>] i</td><td class="doc"><p>a partial result for a failed decoding, together with the remainder of the data passed in so far
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:decodeInc" class="def">decodeInc</a> :: <a href="Codec-Binary-QuotedPrintable.html#t:DecIncData">DecIncData</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Codec-Binary-QuotedPrintable.html#t:DecIncRes">DecIncRes</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Codec-Binary-QuotedPrintable.html#decodeInc" class="link">Source</a></p><div class="doc"><p>Incremental decoder function.
</p></div></div><div class="top"><p class="src"><a name="v:decode" class="def">decode</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word8">Word8</a>]<a href="src/Codec-Binary-QuotedPrintable.html#decode" class="link">Source</a></p><div class="doc"><p>Decode data.
</p></div></div><div class="top"><p class="src"><a name="v:chop" class="def">chop</a><a href="src/Codec-Binary-QuotedPrintable.html#chop" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>length of individual lines (values <code>< 4</code> are ignored)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Chop up a string in parts.
</p></div></div><div class="top"><p class="src"><a name="v:unchop" class="def">unchop</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Codec-Binary-QuotedPrintable.html#unchop" class="link">Source</a></p><div class="doc"><p>Concatenate the list of strings into one long string.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
