/usr/share/doc/libghc-memory-doc/html/Data-ByteArray-Parse.html is in libghc-memory-doc 0.10-1.
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 | <!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.ByteArray.Parse</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-ByteArray-Parse.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-ByteArray-Parse.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">memory-0.10: memory and related abstraction stuff</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>License</th><td>BSD-style</td></tr><tr><th>Maintainer</th><td>Vincent Hanquez <vincent@snarc.org></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>Haskell2010</td></tr></table><p class="caption">Data.ByteArray.Parse</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">run the Parser</a></li><li><a href="#g:2">Parser methods</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A very simple bytearray parser related to Parsec and Attoparsec</p><p>Simple example:</p><pre>> parse ((,,) <$> take 2 <*> byte 0x20 <*> (bytes "abc" *> anyByte)) "xx abctest"
ParseOK "est" ("xx", 116)</pre></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:Parser">Parser</a> byteArray a</li><li class="src short"><span class="keyword">data</span> <a href="#t:Result">Result</a> byteArray a<ul class="subs"><li>= <a href="#v:ParseFail">ParseFail</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></li><li>| <a href="#v:ParseMore">ParseMore</a> (byteArray -> <a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a)</li><li>| <a href="#v:ParseOK">ParseOK</a> byteArray a</li></ul></li><li class="src short"><a href="#v:parse">parse</a> :: <a href="Data-ByteArray.html#t:ByteArrayAccess">ByteArrayAccess</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray a -> byteArray -> <a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a</li><li class="src short"><a href="#v:parseFeed">parseFeed</a> :: (<a href="Data-ByteArray.html#t:ByteArrayAccess">ByteArrayAccess</a> byteArray, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:Monad">Monad</a> m) => m byteArray -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray a -> byteArray -> m (<a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a)</li><li class="src short"><a href="#v:byte">byte</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray ()</li><li class="src short"><a href="#v:anyByte">anyByte</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a></li><li class="src short"><a href="#v:bytes">bytes</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> ba, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> ba, <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> ba) => ba -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> ba ()</li><li class="src short"><a href="#v:take">take</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray</li><li class="src short"><a href="#v:takeWhile">takeWhile</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray</li><li class="src short"><a href="#v:takeAll">takeAll</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray</li><li class="src short"><a href="#v:skip">skip</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray ()</li><li class="src short"><a href="#v:skipWhile">skipWhile</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray ()</li><li class="src short"><a href="#v:skipAll">skipAll</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray ()</li><li class="src short"><a href="#v:takeStorable">takeStorable</a> :: (<a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Foreign-Storable.html#t:Storable">Storable</a> d) => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray d</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Parser" class="def">Parser</a> byteArray a <a href="src/Data-ByteArray-Parse.html#Parser" class="link">Source</a></p><div class="doc"><p>Simple ByteString parser structure</p></div><div class="subs instances"><p id="control.i:Parser" class="caption collapser" onclick="toggleSection('i:Parser')">Instances</p><div id="section.i:Parser" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:Monad">Monad</a> (<a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray)</span> <a href="src/Data-ByteArray-Parse.html#line-73" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> (<a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray)</span> <a href="src/Data-ByteArray-Parse.html#line-83" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Applicative.html#t:Applicative">Applicative</a> (<a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray)</span> <a href="src/Data-ByteArray-Parse.html#line-86" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Applicative.html#t:Alternative">Alternative</a> (<a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray)</span> <a href="src/Data-ByteArray-Parse.html#line-89" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:MonadPlus">MonadPlus</a> (<a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray)</span> <a href="src/Data-ByteArray-Parse.html#line-78" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Result" class="def">Result</a> byteArray a <a href="src/Data-ByteArray-Parse.html#Result" class="link">Source</a></p><div class="doc"><p>Simple parsing result, that represent respectively:</p><ul><li>failure: with the error message</li><li>continuation: that need for more input data</li><li>success: the remaining unparsed data and the parser value</li></ul></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ParseFail" class="def">ParseFail</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ParseMore" class="def">ParseMore</a> (byteArray -> <a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ParseOK" class="def">ParseOK</a> byteArray a</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Result" class="caption collapser" onclick="toggleSection('i:Result')">Instances</p><div id="section.i:Result" class="show"><table><tr><td class="src clearfix"><span class="inst-left">(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> ba, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> (<a href="Data-ByteArray-Parse.html#t:Result">Result</a> ba a)</span> <a href="src/Data-ByteArray-Parse.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:1">run the Parser</h1><div class="top"><p class="src"><a name="v:parse" class="def">parse</a> :: <a href="Data-ByteArray.html#t:ByteArrayAccess">ByteArrayAccess</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray a -> byteArray -> <a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a <a href="src/Data-ByteArray-Parse.html#parse" class="link">Source</a></p><div class="doc"><p>Run a Parser on a ByteString and return a <code><a href="Data-ByteArray-Parse.html#t:Result">Result</a></code></p></div></div><div class="top"><p class="src"><a name="v:parseFeed" class="def">parseFeed</a> :: (<a href="Data-ByteArray.html#t:ByteArrayAccess">ByteArrayAccess</a> byteArray, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:Monad">Monad</a> m) => m byteArray -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray a -> byteArray -> m (<a href="Data-ByteArray-Parse.html#t:Result">Result</a> byteArray a) <a href="src/Data-ByteArray-Parse.html#parseFeed" class="link">Source</a></p><div class="doc"><p>Run a parser on an @initial byteArray.</p><p>If the Parser need more data than available, the @feeder function
is automatically called and fed to the More continuation.</p></div></div><h1 id="g:2">Parser methods</h1><div class="top"><p class="src"><a name="v:byte" class="def">byte</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray () <a href="src/Data-ByteArray-Parse.html#byte" class="link">Source</a></p><div class="doc"><p>Parse a specific byte at current position</p><p>if the byte is different than the expected on,
this parser will raise a failure.</p></div></div><div class="top"><p class="src"><a name="v:anyByte" class="def">anyByte</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> <a href="src/Data-ByteArray-Parse.html#anyByte" class="link">Source</a></p><div class="doc"><p>Get the next byte from the parser</p></div></div><div class="top"><p class="src"><a name="v:bytes" class="def">bytes</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> ba, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> ba, <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> ba) => ba -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> ba () <a href="src/Data-ByteArray-Parse.html#bytes" class="link">Source</a></p><div class="doc"><p>Parse a sequence of bytes from current position</p><p>if the following bytes don't match the expected
bytestring completely, the parser will raise a failure</p></div></div><div class="top"><p class="src"><a name="v:take" class="def">take</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray <a href="src/Data-ByteArray-Parse.html#take" class="link">Source</a></p><div class="doc"><p>Take @n bytes from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:takeWhile" class="def">takeWhile</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray <a href="src/Data-ByteArray-Parse.html#takeWhile" class="link">Source</a></p><div class="doc"><p>Take bytes while the @predicate hold from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:takeAll" class="def">takeAll</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray byteArray <a href="src/Data-ByteArray-Parse.html#takeAll" class="link">Source</a></p><div class="doc"><p>Take the remaining bytes from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:skip" class="def">skip</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray () <a href="src/Data-ByteArray-Parse.html#skip" class="link">Source</a></p><div class="doc"><p>Skip @n bytes from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:skipWhile" class="def">skipWhile</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word8">Word8</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray () <a href="src/Data-ByteArray-Parse.html#skipWhile" class="link">Source</a></p><div class="doc"><p>Skip bytes while the @predicate hold from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:skipAll" class="def">skipAll</a> :: <a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray () <a href="src/Data-ByteArray-Parse.html#skipAll" class="link">Source</a></p><div class="doc"><p>Skip all the remaining bytes from the current position in the stream</p></div></div><div class="top"><p class="src"><a name="v:takeStorable" class="def">takeStorable</a> :: (<a href="Data-ByteArray.html#t:ByteArray">ByteArray</a> byteArray, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Foreign-Storable.html#t:Storable">Storable</a> d) => <a href="Data-ByteArray-Parse.html#t:Parser">Parser</a> byteArray d <a href="src/Data-ByteArray-Parse.html#takeStorable" class="link">Source</a></p><div class="doc"><p>Take a storable from the current position in the stream</p></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>
|