/usr/share/doc/libghc-streaming-commons-doc/html/Data-Streaming-Text.html is in libghc-streaming-commons-doc 0.1.16-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | <!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.Streaming.Text</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Streaming-Text.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Streaming-Text.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">streaming-commons-0.1.16: Common lower-level functions needed by various streaming data libraries</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Data.Streaming.Text</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Streaming</a></li><li><a href="#g:2">Type</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Provides a stream-based approach to decoding Unicode data. Each function
below works the same way: you give it a chunk of data, and it gives back a
<code>DecodeResult</code>. If the parse was a success, then you get a chunk of <code>Text</code>
(possibly empty) and a continuation parsing function. If the parse was a
failure, you get a chunk of successfully decoded <code>Text</code> (possibly empty) and
the unconsumed bytes.</p><p>In order to indicate end of stream, you pass an empty <code>ByteString</code> to the
decode function. This call may result in a failure, if there were unused
bytes left over from a previous step which formed part of a code sequence.</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:decodeUtf8">decodeUtf8</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><a href="#v:decodeUtf8Pure">decodeUtf8Pure</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><a href="#v:decodeUtf16LE">decodeUtf16LE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><a href="#v:decodeUtf16BE">decodeUtf16BE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><a href="#v:decodeUtf32LE">decodeUtf32LE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><a href="#v:decodeUtf32BE">decodeUtf32BE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:DecodeResult">DecodeResult</a><ul class="subs"><li>= <a href="#v:DecodeResultSuccess">DecodeResultSuccess</a> !<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a> !(<a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a>)</li><li>| <a href="#v:DecodeResultFailure">DecodeResultFailure</a> !<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li></ul></li></ul></div><div id="interface"><h1 id="g:1">Streaming</h1><div class="top"><p class="src"><a id="v:decodeUtf8" class="def">decodeUtf8</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf8" class="link">Source</a> <a href="#v:decodeUtf8" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using
UTF-8 encoding.</p></div></div><div class="top"><p class="src"><a id="v:decodeUtf8Pure" class="def">decodeUtf8Pure</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf8Pure" class="link">Source</a> <a href="#v:decodeUtf8Pure" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using
UTF-8 encoding.</p></div></div><div class="top"><p class="src"><a id="v:decodeUtf16LE" class="def">decodeUtf16LE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf16LE" class="link">Source</a> <a href="#v:decodeUtf16LE" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using little
endian UTF-16 encoding.</p></div></div><div class="top"><p class="src"><a id="v:decodeUtf16BE" class="def">decodeUtf16BE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf16BE" class="link">Source</a> <a href="#v:decodeUtf16BE" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using big
endian UTF-16 encoding.</p></div></div><div class="top"><p class="src"><a id="v:decodeUtf32LE" class="def">decodeUtf32LE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf32LE" class="link">Source</a> <a href="#v:decodeUtf32LE" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using little
endian UTF-32 encoding.</p></div></div><div class="top"><p class="src"><a id="v:decodeUtf32BE" class="def">decodeUtf32BE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a> <a href="src/Data-Streaming-Text.html#decodeUtf32BE" class="link">Source</a> <a href="#v:decodeUtf32BE" class="selflink">#</a></p><div class="doc"><p><em>O(n)</em> Convert a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></code> into a 'Stream Char', using big
endian UTF-32 encoding.</p></div></div><h1 id="g:2">Type</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:DecodeResult" class="def">DecodeResult</a> <a href="src/Data-Streaming-Text.html#DecodeResult" class="link">Source</a> <a href="#t:DecodeResult" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:DecodeResultSuccess" class="def">DecodeResultSuccess</a> !<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a> !(<a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Data-Streaming-Text.html#t:DecodeResult">DecodeResult</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:DecodeResultFailure" class="def">DecodeResultFailure</a> !<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr></table></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|