/usr/share/doc/libghc-conduit-extra-doc/html/Data-Conduit-Binary.html is in libghc-conduit-extra-doc 1.1.13.3-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 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | <!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.Conduit.Binary</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-Conduit-Binary.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Conduit-Binary.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">conduit-extra-1.1.13.3: Batteries included conduit: adapters for common 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.Conduit.Binary</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Files and <code>Handle</code>s</a><ul><li><a href="#g:2">Sources</a></li><li><a href="#g:3">Sinks</a></li><li><a href="#g:4">Conduits</a></li></ul></li><li><a href="#g:5">Utilities</a><ul><li><a href="#g:6">Sources</a></li><li><a href="#g:7">Sinks</a><ul><li><a href="#g:8">Storable</a></li></ul></li><li><a href="#g:9">Conduits</a></li></ul></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Functions for interacting with bytes.</p><p>For many purposes, it's recommended to use the conduit-combinators library,
which provides a more complete set of functions.</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:sourceFile">sourceFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceHandle">sourceHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceHandleUnsafe">sourceHandleUnsafe</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceIOHandle">sourceIOHandle</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceFileRange">sourceFileRange</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceHandleRange">sourceHandleRange</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceHandleRangeWithBuffer">sourceHandleRangeWithBuffer</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</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="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sinkFile">sinkFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:sinkHandle">sinkHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:sinkIOHandle">sinkIOHandle</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:conduitFile">conduitFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:conduitHandle">conduitHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:sourceLbs">sourceLbs</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:head">head</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</a>)</li><li class="src short"><a href="#v:dropWhile">dropWhile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</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="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:take">take</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:drop">drop</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:sinkCacheLength">sinkCacheLength</a> :: (<a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m1, <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m2) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m1 (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m2 <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:sinkLbs">sinkLbs</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:mapM_">mapM_</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</a> -> m ()) -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m ()</li><li class="src short"><a href="#v:sinkStorable">sinkStorable</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Foreign-Storable.html#t:Storable">Storable</a> a) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</li><li class="src short"><a href="#v:sinkStorableEx">sinkStorableEx</a> :: (<a href="file:///usr/share/doc/libghc-exceptions-doc/html/Control-Monad-Catch.html#t:MonadThrow">MonadThrow</a> m, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Foreign-Storable.html#t:Storable">Storable</a> a) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m a</li><li class="src short"><a href="#v:isolate">isolate</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:takeWhile">takeWhile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</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="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:lines">lines</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a></li></ul></div><div id="interface"><h1 id="g:1">Files and <code>Handle</code>s</h1><div class="doc"><p>Note that most of these functions live in the <code>MonadResource</code> monad
to ensure resource finalization even in the presence of exceptions. In
order to run such code, you will need to use <code>runResourceT</code>.</p></div><h2 id="g:2">Sources</h2><div class="top"><p class="src"><a id="v:sourceFile" class="def">sourceFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sourceFile" class="link">Source</a> <a href="#v:sourceFile" class="selflink">#</a></p><div class="doc"><p>Stream the contents of a file as binary data.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sourceHandle" class="def">sourceHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sourceHandle" class="link">Source</a> <a href="#v:sourceHandle" class="selflink">#</a></p><div class="doc"><p>Stream the contents of a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code> as binary data. Note that this
function will <em>not</em> automatically close the <code>Handle</code> when processing
completes, since it did not acquire the <code>Handle</code> in the first place.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sourceHandleUnsafe" class="def">sourceHandleUnsafe</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sourceHandleUnsafe" class="link">Source</a> <a href="#v:sourceHandleUnsafe" class="selflink">#</a></p><div class="doc"><p>Same as <code>sourceHandle</code>, but instead of allocating a new buffer for each
incoming chunk of data, reuses the same buffer. Therefore, the <code>ByteString</code>s
yielded by this function are not referentially transparent between two
different <code>yield</code>s.</p><p>This function will be slightly more efficient than <code>sourceHandle</code> by
avoiding allocations and reducing garbage collections, but should only be
used if you can guarantee that you do not reuse a <code>ByteString</code> (or any slice
thereof) between two calls to <code>await</code>.</p><p>Since 1.0.12</p></div></div><div class="top"><p class="src"><a id="v:sourceIOHandle" class="def">sourceIOHandle</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sourceIOHandle" class="link">Source</a> <a href="#v:sourceIOHandle" class="selflink">#</a></p><div class="doc"><p>An alternative to <code><a href="Data-Conduit-Binary.html#v:sourceHandle">sourceHandle</a></code>.
Instead of taking a pre-opened <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code>, it takes an action that opens
a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code> (in read mode), so that it can open it only when needed
and close it as soon as possible.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sourceFileRange" class="def">sourceFileRange</a> <a href="src/Data-Conduit-Binary.html#sourceFileRange" class="link">Source</a> <a href="#v:sourceFileRange" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Offset</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Maximum count</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <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 class="doc"><p>Stream the contents of a file as binary data, starting from a certain
offset and only consuming up to a certain number of bytes.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sourceHandleRange" class="def">sourceHandleRange</a> <a href="src/Data-Conduit-Binary.html#sourceHandleRange" class="link">Source</a> <a href="#v:sourceHandleRange" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Offset</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Maximum count</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <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 class="doc"><p>Stream the contents of a handle as binary data, starting from a certain
offset and only consuming up to a certain number of bytes.</p><p>Since 1.0.8</p></div></div><div class="top"><p class="src"><a id="v:sourceHandleRangeWithBuffer" class="def">sourceHandleRangeWithBuffer</a> <a href="src/Data-Conduit-Binary.html#sourceHandleRangeWithBuffer" class="link">Source</a> <a href="#v:sourceHandleRangeWithBuffer" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Offset</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc"><p>Maximum count</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Buffer size</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <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 class="doc"><p>Stream the contents of a handle as binary data, starting from a certain
offset and only consuming up to a certain number of bytes. This function
consumes chunks as specified by the buffer size.</p><p>Since 1.1.8</p></div></div><h2 id="g:3">Sinks</h2><div class="top"><p class="src"><a id="v:sinkFile" class="def">sinkFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#sinkFile" class="link">Source</a> <a href="#v:sinkFile" class="selflink">#</a></p><div class="doc"><p>Stream all incoming data to the given file.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sinkHandle" class="def">sinkHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#sinkHandle" class="link">Source</a> <a href="#v:sinkHandle" class="selflink">#</a></p><div class="doc"><p>Stream all incoming data to the given <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code>. Note that this function
will <em>not</em> automatically close the <code>Handle</code> when processing completes.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:sinkIOHandle" class="def">sinkIOHandle</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#sinkIOHandle" class="link">Source</a> <a href="#v:sinkIOHandle" class="selflink">#</a></p><div class="doc"><p>An alternative to <code><a href="Data-Conduit-Binary.html#v:sinkHandle">sinkHandle</a></code>.
Instead of taking a pre-opened <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code>, it takes an action that opens
a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a></code> (in write mode), so that it can open it only when needed
and close it as soon as possible.</p><p>Since 0.3.0</p></div></div><h2 id="g:4">Conduits</h2><div class="top"><p class="src"><a id="v:conduitFile" class="def">conduitFile</a> :: <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#conduitFile" class="link">Source</a> <a href="#v:conduitFile" class="selflink">#</a></p><div class="doc"><p>Stream the contents of the input to a file, and also send it along the
pipeline. Similar in concept to the Unix command <code>tee</code>.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:conduitHandle" class="def">conduitHandle</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#conduitHandle" class="link">Source</a> <a href="#v:conduitHandle" class="selflink">#</a></p><div class="doc"><p>Stream the contents of the input to a <code>Handle</code>, and also send it along the
pipeline. Similar in concept to the Unix command <code>tee</code>. Like <code>sourceHandle</code>,
does not close the handle on completion. Related to: <code>conduitFile</code>.</p><p>Since 1.0.9</p></div></div><h1 id="g:5">Utilities</h1><h2 id="g:6">Sources</h2><div class="top"><p class="src"><a id="v:sourceLbs" class="def">sourceLbs</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Producer">Producer</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sourceLbs" class="link">Source</a> <a href="#v:sourceLbs" class="selflink">#</a></p><div class="doc"><p>Stream the chunks from a lazy bytestring.</p><p>Since 0.5.0</p></div></div><h2 id="g:7">Sinks</h2><div class="top"><p class="src"><a id="v:head" class="def">head</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</a>) <a href="src/Data-Conduit-Binary.html#head" class="link">Source</a> <a href="#v:head" class="selflink">#</a></p><div class="doc"><p>Return the next byte from the stream, if available.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:dropWhile" class="def">dropWhile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</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="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#dropWhile" class="link">Source</a> <a href="#v:dropWhile" class="selflink">#</a></p><div class="doc"><p>Ignore all bytes while the predicate returns <code>True</code>.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:take" class="def">take</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#take" class="link">Source</a> <a href="#v:take" class="selflink">#</a></p><div class="doc"><p>Take the given number of bytes, if available.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:drop" class="def">drop</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#drop" class="link">Source</a> <a href="#v:drop" class="selflink">#</a></p><div class="doc"><p>Drop up to the given number of bytes.</p><p>Since 0.5.0</p></div></div><div class="top"><p class="src"><a id="v:sinkCacheLength" class="def">sinkCacheLength</a> :: (<a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m1, <a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#t:MonadResource">MonadResource</a> m2) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m1 (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m2 <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a>) <a href="src/Data-Conduit-Binary.html#sinkCacheLength" class="link">Source</a> <a href="#v:sinkCacheLength" class="selflink">#</a></p><div class="doc"><p>Stream the input data into a temp file and count the number of bytes
present. When complete, return a new <code>Source</code> reading from the temp file
together with the length of the input in bytes.</p><p>All resources will be cleaned up automatically.</p><p>Since 1.0.5</p></div></div><div class="top"><p class="src"><a id="v:sinkLbs" class="def">sinkLbs</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#sinkLbs" class="link">Source</a> <a href="#v:sinkLbs" class="selflink">#</a></p><div class="doc"><p>Consume a stream of input into a lazy bytestring. Note that no lazy I/O
is performed, but rather all content is read into memory strictly.</p><p>Since 1.0.5</p></div></div><div class="top"><p class="src"><a id="v:mapM_" class="def">mapM_</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</a> -> m ()) -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m () <a href="src/Data-Conduit-Binary.html#mapM_" class="link">Source</a> <a href="#v:mapM_" class="selflink">#</a></p><div class="doc"><p>Perform a computation on each <code>Word8</code> in a stream.</p><p>Since 1.0.10</p></div></div><h3 id="g:8">Storable</h3><div class="top"><p class="src"><a id="v:sinkStorable" class="def">sinkStorable</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Foreign-Storable.html#t:Storable">Storable</a> a) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) <a href="src/Data-Conduit-Binary.html#sinkStorable" class="link">Source</a> <a href="#v:sinkStorable" class="selflink">#</a></p><div class="doc"><p>Consume some instance of <code>Storable</code> from the incoming byte stream. In the
event of insufficient bytes in the stream, returns a <code>Nothing</code> and returns
all unused input as leftovers.</p><p><em>Since: 1.1.13</em></p></div></div><div class="top"><p class="src"><a id="v:sinkStorableEx" class="def">sinkStorableEx</a> :: (<a href="file:///usr/share/doc/libghc-exceptions-doc/html/Control-Monad-Catch.html#t:MonadThrow">MonadThrow</a> m, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Foreign-Storable.html#t:Storable">Storable</a> a) => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m a <a href="src/Data-Conduit-Binary.html#sinkStorableEx" class="link">Source</a> <a href="#v:sinkStorableEx" class="selflink">#</a></p><div class="doc"><p>Same as <code><a href="Data-Conduit-Binary.html#v:sinkStorable">sinkStorable</a></code>, but throws a <code>SinkStorableInsufficientBytes</code>
exception (via <code><a href="file:///usr/share/doc/libghc-exceptions-doc/html/Control-Monad-Catch.html#v:throwM">throwM</a></code>) in the event of insufficient bytes. This can be
more efficient to use than <code><a href="Data-Conduit-Binary.html#v:sinkStorable">sinkStorable</a></code> as it avoids the need to
construct/deconstruct a <code>Maybe</code> wrapper in the success case.</p><p><em>Since: 1.1.13</em></p></div></div><h2 id="g:9">Conduits</h2><div class="top"><p class="src"><a id="v:isolate" class="def">isolate</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#isolate" class="link">Source</a> <a href="#v:isolate" class="selflink">#</a></p><div class="doc"><p>Ensure that only up to the given number of bytes are consumed by the inner
sink. Note that this does <em>not</em> ensure that all of those bytes are in fact
consumed.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:takeWhile" class="def">takeWhile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Word.html#t:Word8">Word8</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="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#takeWhile" class="link">Source</a> <a href="#v:takeWhile" class="selflink">#</a></p><div class="doc"><p>Return all bytes while the predicate returns <code>True</code>.</p><p>Since 0.3.0</p></div></div><div class="top"><p class="src"><a id="v:lines" class="def">lines</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Conduit">Conduit</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> m <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString.html#t:ByteString">ByteString</a> <a href="src/Data-Conduit-Binary.html#lines" class="link">Source</a> <a href="#v:lines" class="selflink">#</a></p><div class="doc"><p>Split the input bytes into lines. In other words, split on the LF byte
(10), and strip it from the output.</p><p>Since 0.3.0</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>
|