/usr/share/doc/libghc-text-doc/html/Data-Text-Internal-Lazy.html is in libghc-text-doc 1.2.2.1-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 | <!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.Text.Internal.Lazy</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-Text-Internal-Lazy.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Text-Internal-Lazy.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">text-1.2.2.1: An efficient packed Unicode text type.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) 2009, 2010 Bryan O'Sullivan</td></tr><tr><th>License</th><td>BSD-style</td></tr><tr><th>Maintainer</th><td>bos@serpentine.com</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>GHC</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Data.Text.Internal.Lazy</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Data type invariant and abstraction functions</a></li><li><a href="#g:2">Chunk allocation sizes</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p><em>Warning</em>: this is an internal module, and does not have a stable
API or name. Functions in this module may not check or enforce
preconditions expected by public modules. Use at your own risk!</p><p>A module containing private <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> internals. This exposes the
<code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> representation and low level construction functions.
Modules which extend the <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> system may need to use this module.</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:Text">Text</a><ul class="subs"><li>= <a href="#v:Empty">Empty</a></li><li>| <a href="#v:Chunk">Chunk</a> !<a href="Data-Text.html#t:Text">Text</a> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></li></ul></li><li class="src short"><a href="#v:chunk">chunk</a> :: <a href="Data-Text.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></li><li class="src short"><a href="#v:empty">empty</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></li><li class="src short"><a href="#v:foldrChunks">foldrChunks</a> :: (<a href="Data-Text.html#t:Text">Text</a> -> a -> a) -> a -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> a</li><li class="src short"><a href="#v:foldlChunks">foldlChunks</a> :: (a -> <a href="Data-Text.html#t:Text">Text</a> -> a) -> a -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> a</li><li class="src short"><a href="#v:strictInvariant">strictInvariant</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:lazyInvariant">lazyInvariant</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></li><li class="src short"><a href="#v:showStructure">showStructure</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:defaultChunkSize">defaultChunkSize</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:smallChunkSize">smallChunkSize</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:chunkOverhead">chunkOverhead</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Text" class="def">Text</a> <a href="src/Data-Text-Internal-Lazy.html#Text" class="link">Source</a> <a href="#t:Text" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Empty" class="def">Empty</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Chunk" class="def">Chunk</a> !<a href="Data-Text.html#t:Text">Text</a> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Text" class="caption collapser" onclick="toggleSection('i:Text')">Instances</p><div id="section.i:Text" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Text:Item:1" class="instance expander" onclick="toggleSection('i:id:Text:Item:1')"></span> <span class="keyword">type</span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Exts.html#t:Item">Item</a> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></span> <a href="#t:Item" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Text:Item:1" class="inst-details hide"><div class="src"><span class="keyword">type</span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Exts.html#t:Item">Item</a> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Char.html#t:Char">Char</a></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:chunk" class="def">chunk</a> :: <a href="Data-Text.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> <a href="src/Data-Text-Internal-Lazy.html#chunk" class="link">Source</a> <a href="#v:chunk" class="selflink">#</a></p><div class="doc"><p>Smart constructor for <code><a href="Data-Text-Internal-Lazy.html#v:Chunk">Chunk</a></code>. Guarantees the data type invariant.</p></div></div><div class="top"><p class="src"><a id="v:empty" class="def">empty</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> <a href="src/Data-Text-Internal-Lazy.html#empty" class="link">Source</a> <a href="#v:empty" class="selflink">#</a></p><div class="doc"><p>Smart constructor for <code><a href="Data-Text-Internal-Lazy.html#v:Empty">Empty</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:foldrChunks" class="def">foldrChunks</a> :: (<a href="Data-Text.html#t:Text">Text</a> -> a -> a) -> a -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> a <a href="src/Data-Text-Internal-Lazy.html#foldrChunks" class="link">Source</a> <a href="#v:foldrChunks" class="selflink">#</a></p><div class="doc"><p>Consume the chunks of a lazy <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> with a natural right fold.</p></div></div><div class="top"><p class="src"><a id="v:foldlChunks" class="def">foldlChunks</a> :: (a -> <a href="Data-Text.html#t:Text">Text</a> -> a) -> a -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> a <a href="src/Data-Text-Internal-Lazy.html#foldlChunks" class="link">Source</a> <a href="#v:foldlChunks" class="selflink">#</a></p><div class="doc"><p>Consume the chunks of a lazy <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> with a strict, tail-recursive,
accumulating left fold.</p></div></div><h1 id="g:1">Data type invariant and abstraction functions</h1><div class="doc"><p>The data type invariant for lazy <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code>: Every <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code> is either <code><a href="Data-Text-Internal-Lazy.html#v:Empty">Empty</a></code> or
consists of non-null <code><a href="Data-Text.html#t:Text">Text</a></code>s. All functions must preserve this,
and the QC properties must check this.</p></div><div class="top"><p class="src"><a id="v:strictInvariant" class="def">strictInvariant</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Data-Text-Internal-Lazy.html#strictInvariant" class="link">Source</a> <a href="#v:strictInvariant" class="selflink">#</a></p><div class="doc"><p>Check the invariant strictly.</p></div></div><div class="top"><p class="src"><a id="v:lazyInvariant" class="def">lazyInvariant</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> <a href="src/Data-Text-Internal-Lazy.html#lazyInvariant" class="link">Source</a> <a href="#v:lazyInvariant" class="selflink">#</a></p><div class="doc"><p>Check the invariant lazily.</p></div></div><div class="top"><p class="src"><a id="v:showStructure" class="def">showStructure</a> :: <a href="Data-Text-Internal-Lazy.html#t:Text">Text</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="src/Data-Text-Internal-Lazy.html#showStructure" class="link">Source</a> <a href="#v:showStructure" class="selflink">#</a></p><div class="doc"><p>Display the internal structure of a lazy <code><a href="Data-Text-Internal-Lazy.html#t:Text">Text</a></code>.</p></div></div><h1 id="g:2">Chunk allocation sizes</h1><div class="top"><p class="src"><a id="v:defaultChunkSize" class="def">defaultChunkSize</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Data-Text-Internal-Lazy.html#defaultChunkSize" class="link">Source</a> <a href="#v:defaultChunkSize" class="selflink">#</a></p><div class="doc"><p>Currently set to 16 KiB, less the memory management overhead.</p></div></div><div class="top"><p class="src"><a id="v:smallChunkSize" class="def">smallChunkSize</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Data-Text-Internal-Lazy.html#smallChunkSize" class="link">Source</a> <a href="#v:smallChunkSize" class="selflink">#</a></p><div class="doc"><p>Currently set to 128 bytes, less the memory management overhead.</p></div></div><div class="top"><p class="src"><a id="v:chunkOverhead" class="def">chunkOverhead</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Data-Text-Internal-Lazy.html#chunkOverhead" class="link">Source</a> <a href="#v:chunkOverhead" class="selflink">#</a></p><div class="doc"><p>The memory management overhead. Currently this is tuned for GHC only.</p></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>
|