<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Lwt_sequence.html">
<link rel="next" href="Lwt_switch.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Lwt_condition" rel="Chapter" href="Lwt_condition.html">
<link title="Lwt_list" rel="Chapter" href="Lwt_list.html">
<link title="Lwt" rel="Chapter" href="Lwt.html">
<link title="Lwt_mutex" rel="Chapter" href="Lwt_mutex.html">
<link title="Lwt_mvar" rel="Chapter" href="Lwt_mvar.html">
<link title="Lwt_pool" rel="Chapter" href="Lwt_pool.html">
<link title="Lwt_sequence" rel="Chapter" href="Lwt_sequence.html">
<link title="Lwt_stream" rel="Chapter" href="Lwt_stream.html">
<link title="Lwt_switch" rel="Chapter" href="Lwt_switch.html">
<link title="Lwt_util" rel="Chapter" href="Lwt_util.html">
<link title="Lwt_pqueue" rel="Chapter" href="Lwt_pqueue.html">
<link title="Lwt_lib" rel="Chapter" href="Lwt_lib.html">
<link title="Lwt_glib" rel="Chapter" href="Lwt_glib.html">
<link title="Lwt_preemptive" rel="Chapter" href="Lwt_preemptive.html">
<link title="Lwt_event" rel="Chapter" href="Lwt_event.html">
<link title="Lwt_signal" rel="Chapter" href="Lwt_signal.html">
<link title="Lwt_react" rel="Chapter" href="Lwt_react.html">
<link title="Lwt_ssl" rel="Chapter" href="Lwt_ssl.html">
<link title="Lwt_text" rel="Chapter" href="Lwt_text.html">
<link title="Lwt_term" rel="Chapter" href="Lwt_term.html">
<link title="Lwt_read_line" rel="Chapter" href="Lwt_read_line.html">
<link title="Lwt_top" rel="Chapter" href="Lwt_top.html">
<link title="Lwt_chan" rel="Chapter" href="Lwt_chan.html">
<link title="Lwt_daemon" rel="Chapter" href="Lwt_daemon.html">
<link title="Lwt_gc" rel="Chapter" href="Lwt_gc.html">
<link title="Lwt_io" rel="Chapter" href="Lwt_io.html">
<link title="Lwt_log" rel="Chapter" href="Lwt_log.html">
<link title="Lwt_main" rel="Chapter" href="Lwt_main.html">
<link title="Lwt_process" rel="Chapter" href="Lwt_process.html">
<link title="Lwt_throttle" rel="Chapter" href="Lwt_throttle.html">
<link title="Lwt_timeout" rel="Chapter" href="Lwt_timeout.html">
<link title="Lwt_unix" rel="Chapter" href="Lwt_unix.html">
<link title="Lwt_sys" rel="Chapter" href="Lwt_sys.html">
<link title="Lwt_engine" rel="Chapter" href="Lwt_engine.html">
<link title="Lwt_bytes" rel="Chapter" href="Lwt_bytes.html">
<link title="Pa_lwt" rel="Chapter" href="Pa_lwt.html">
<link title="Pa_lwt_log" rel="Chapter" href="Pa_lwt_log.html"><link title="Construction" rel="Section" href="#6_Construction">
<link title="Destruction" rel="Section" href="#6_Destruction">
<link title="Data retreival" rel="Section" href="#6_Dataretreival">
<link title="Stream transversal" rel="Section" href="#6_Streamtransversal">
<link title="Parsing" rel="Section" href="#6_Parsing">
<link title="Misc" rel="Section" href="#6_Misc">
<title>Lwt_stream</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_sequence.html" title="Lwt_sequence">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Lwt_switch.html" title="Lwt_switch">Next</a>
</div>
<h1>Module <a href="type_Lwt_stream.html">Lwt_stream</a></h1>
<pre><span class="keyword">module</span> Lwt_stream: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_stream.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Data streams<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
<div class="info">
Type of a stream holding values of type <code class="code"><span class="keywordsign">'</span>a</code><br>
</div>
<br>
Naming convention: in this module all function taking a function
which is applied to all element of the streams are suffixed by:
<p>
<ul>
<li><code class="code">_s</code> when the function returns a thread and calls are serialised</li>
<li><code class="code">_p</code> when the function returns a thread and calls are parallelised</li>
</ul>
<br>
<br>
<h6 id="6_Construction">Construction</h6><br>
<pre><span id="VALfrom"><span class="keyword">val</span> from</span> : <code class="type">(unit -> 'a option <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">from f</code> creates an stream from the given input function. <code class="code">f</code> is
called each time more input is needed, and the stream ends when
<code class="code">f</code> returns <code class="code"><span class="constructor">None</span></code>.<br>
</div>
<pre><span id="VALfrom_direct"><span class="keyword">val</span> from_direct</span> : <code class="type">(unit -> 'a option) -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">from_direct f</code> does the same as <a href="Lwt_stream.html#VALfrom"><code class="code"><span class="constructor">Lwt_stream</span>.from</code></a> but with a function
that does not return a thread. It is better than wrapping <code class="code">f</code>
into a function which return a thread.<br>
</div>
<pre><span id="EXCEPTIONClosed"><span class="keyword">exception</span> Closed</span></pre>
<div class="info">
Exception raised by the push function of a push-stream when
pushing an element after the end of stream (<code class="code">= <span class="constructor">None</span></code>) have been
pushed.<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">unit -> 'a <a href="Lwt_stream.html#TYPEt">t</a> * ('a option -> unit)</code></pre><div class="info">
<code class="code">create ()</code> returns a new stream and a push function.<br>
</div>
<pre><span id="VALcreate_with_reference"><span class="keyword">val</span> create_with_reference</span> : <code class="type">unit -> 'a <a href="Lwt_stream.html#TYPEt">t</a> * ('a option -> unit) * ('b -> unit)</code></pre><div class="info">
<code class="code">create_with_reference ()</code> returns a new stream and a push
function. The last function allows to set a reference to an
external source. This prevent the external source from being
garbage collected.
<p>
For example, to convert a reactive event to a stream:
<p>
<pre class="codepre"><code class="code"> <span class="keyword">let</span> stream, push, set_ref = <span class="constructor">Lwt_stream</span>.create_with_reference () <span class="keyword">in</span><br>
set_ref (map_event push event)<br>
</code></pre><br>
</div>
<pre><span id="EXCEPTIONFull"><span class="keyword">exception</span> Full</span></pre>
<div class="info">
Exception raised by the push function of a bounded push-stream
when the stream queue is full and a thread is already waiting to
push an element.<br>
</div>
<pre><span id="TYPEbounded_push"><span class="keyword">class type</span> <code class="type">['a]</code> <a href="Lwt_stream.bounded_push-c.html">bounded_push</a></span> = <code class="code"><span class="keyword">object</span></code> <a href="Lwt_stream.bounded_push-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Type of sources for bounded push-streams.
</div>
<pre><span id="VALcreate_bounded"><span class="keyword">val</span> create_bounded</span> : <code class="type">int -> 'a <a href="Lwt_stream.html#TYPEt">t</a> * 'a <a href="Lwt_stream.bounded_push-c.html">bounded_push</a></code></pre><div class="info">
<code class="code">create_bounded size</code> returns a new stream and a bounded push
source. The stream can hold a maximum of <code class="code">size</code> elements. When
this limit is reached, pushing a new element will block until
one is consumed.
<p>
Note that you cannot clone or parse (with <a href="Lwt_stream.html#VALparse"><code class="code"><span class="constructor">Lwt_stream</span>.parse</code></a>) a bounded
stream. These functions will raise <code class="code"><span class="constructor">Invalid_argument</span></code> if you try
to do so.
<p>
It raises <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">size < 0</code>.<br>
</div>
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">'a list -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">of_list l</code> creates a stream returning all elements of <code class="code">l</code><br>
</div>
<pre><span id="VALof_array"><span class="keyword">val</span> of_array</span> : <code class="type">'a array -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">of_array a</code> creates a stream returning all elements of <code class="code">a</code><br>
</div>
<pre><span id="VALof_string"><span class="keyword">val</span> of_string</span> : <code class="type">string -> char <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">of_string str</code> creates a stream returning all characters of
<code class="code">str</code><br>
</div>
<pre><span id="VALclone"><span class="keyword">val</span> clone</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">clone st</code> clone the given stream. Operations on each stream
will not affect the other.
<p>
For example:
<p>
<pre class="codepre"><code class="code"> <span class="keywordsign">#</span> <span class="keyword">let</span> st1 = <span class="constructor">Lwt_stream</span>.of_list [1; 2; 3];;<br>
<span class="keyword">val</span> st1 : int <span class="constructor">Lwt_stream</span>.t = <abstr><br>
<span class="keywordsign">#</span> <span class="keyword">let</span> st2 = <span class="constructor">Lwt_stream</span>.clone st1;;<br>
<span class="keyword">val</span> st2 : int <span class="constructor">Lwt_stream</span>.t = <abstr><br>
<span class="keywordsign">#</span> lwt x = <span class="constructor">Lwt_stream</span>.next st1;;<br>
<span class="keyword">val</span> x : int = 1<br>
<span class="keywordsign">#</span> lwt y = <span class="constructor">Lwt_stream</span>.next st2;;<br>
<span class="keyword">val</span> y : int = 1<br>
</code></pre>
<p>
It raises <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">st</code> is a bounded
push-stream.<br>
</div>
<br>
<h6 id="6_Destruction">Destruction</h6><br>
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
Returns the list of elements of the given stream<br>
</div>
<pre><span id="VALto_string"><span class="keyword">val</span> to_string</span> : <code class="type">char <a href="Lwt_stream.html#TYPEt">t</a> -> string <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
Returns the word composed of all characters of the given
stream<br>
</div>
<br>
<h6 id="6_Dataretreival">Data retreival</h6><br>
<pre><span id="EXCEPTIONEmpty"><span class="keyword">exception</span> Empty</span></pre>
<div class="info">
Exception raised when trying to retreive data from an empty
stream.<br>
</div>
<pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">peek st</code> returns the first element of the stream, if any,
without removing it.<br>
</div>
<pre><span id="VALnpeek"><span class="keyword">val</span> npeek</span> : <code class="type">int -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">npeek n st</code> returns at most the first <code class="code">n</code> elements of <code class="code">st</code>,
without removing them.<br>
</div>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">get st</code> remove and returns the first element of the stream, if
any.<br>
</div>
<pre><span id="VALnget"><span class="keyword">val</span> nget</span> : <code class="type">int -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">nget n st</code> remove and returns at most the first <code class="code">n</code> elements of
<code class="code">st</code>.<br>
</div>
<pre><span id="VALget_while"><span class="keyword">val</span> get_while</span> : <code class="type">('a -> bool) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALget_while_s"><span class="keyword">val</span> get_while_s</span> : <code class="type">('a -> bool <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">get_while f st</code> returns the longest prefix of <code class="code">st</code> where all
elements satisfy <code class="code">f</code>.<br>
</div>
<pre><span id="VALnext"><span class="keyword">val</span> next</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">next st</code> remove and returns the next element of the stream, of
fail with <a href="Lwt_stream.html#EXCEPTIONEmpty"><code class="code"><span class="constructor">Lwt_stream</span>.<span class="constructor">Empty</span></code></a> if the stream is empty.<br>
</div>
<pre><span id="VALlast_new"><span class="keyword">val</span> last_new</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">last_new st</code> returns the last element that can be obtained
without sleepping, or wait for one if no one is already
available.
<p>
If fails with <a href="Lwt_stream.html#EXCEPTIONEmpty"><code class="code"><span class="constructor">Lwt_stream</span>.<span class="constructor">Empty</span></code></a> if the stream has no more elements<br>
</div>
<pre><span id="VALjunk"><span class="keyword">val</span> junk</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">junk st</code> remove the first element of <code class="code">st</code>.<br>
</div>
<pre><span id="VALnjunk"><span class="keyword">val</span> njunk</span> : <code class="type">int -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">njunk n st</code> removes at most the first <code class="code">n</code> elements of the
stream.<br>
</div>
<pre><span id="VALjunk_while"><span class="keyword">val</span> junk_while</span> : <code class="type">('a -> bool) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALjunk_while_s"><span class="keyword">val</span> junk_while_s</span> : <code class="type">('a -> bool <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">junk_while f st</code> removes all elements at the beginning of the
streams which satisfy <code class="code">f</code>.<br>
</div>
<pre><span id="VALjunk_old"><span class="keyword">val</span> junk_old</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">junk_old st</code> removes all elements that are ready to be read
without yeilding from <code class="code">st</code>.
<p>
For example the <code class="code">read_password</code> function of <code class="code"><span class="constructor">Lwt_read_line</span></code> use
that to junk key previously typed by the user.<br>
</div>
<pre><span id="VALget_available"><span class="keyword">val</span> get_available</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list</code></pre><div class="info">
<code class="code">get_available st</code> returns all available elements of <code class="code">l</code> without
blocking<br>
</div>
<pre><span id="VALget_available_up_to"><span class="keyword">val</span> get_available_up_to</span> : <code class="type">int -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a list</code></pre><div class="info">
<code class="code">get_available_up_to n st</code> returns up to <code class="code">n</code> elements of <code class="code">l</code>
without blocking<br>
</div>
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> bool <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">is_empty st</code> returns wether the given stream is empty<br>
</div>
<pre><span id="VALon_terminate"><span class="keyword">val</span> on_terminate</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> (unit -> unit) -> unit</code></pre><div class="info">
<code class="code">on_terminate st f</code> executes <code class="code">f</code> when the end of the stream <code class="code">st</code>
is reached. Note that the stream may still contains elements if
<a href="Lwt_stream.html#VALpeek"><code class="code"><span class="constructor">Lwt_stream</span>.peek</code></a> or similar was used.<br>
</div>
<br>
<h6 id="6_Streamtransversal">Stream transversal</h6><br>
<br>
Note: all the following functions are destructive.
<p>
For example:
<p>
<pre class="codepre"><code class="code"> <span class="keywordsign">#</span> <span class="keyword">let</span> st1 = <span class="constructor">Lwt_stream</span>.of_list [1; 2; 3];;<br>
<span class="keyword">val</span> st1 : int <span class="constructor">Lwt_stream</span>.t = <abstr><br>
<span class="keywordsign">#</span> <span class="keyword">let</span> st2 = <span class="constructor">Lwt_stream</span>.map string_of_int st1;;<br>
<span class="keyword">val</span> st2 : string <span class="constructor">Lwt_stream</span>.t = <abstr><br>
<span class="keywordsign">#</span> lwt x = <span class="constructor">Lwt_stream</span>.next st1;;<br>
<span class="keyword">val</span> x : int = 1<br>
<span class="keywordsign">#</span> lwt y = <span class="constructor">Lwt_stream</span>.next st2;;<br>
<span class="keyword">val</span> y : string = <span class="string">"2"</span><br>
</code></pre><br>
<pre><span id="VALchoose"><span class="keyword">val</span> choose</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> list -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">choose l</code> creates an stream from a list of streams. The
resulting stream will returns elements returned by any stream of
<code class="code">l</code> in an unspecified order.<br>
</div>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><pre><span id="VALmap_s"><span class="keyword">val</span> map_s</span> : <code class="type">('a -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">map f st</code> maps the value returned by <code class="code">st</code> with <code class="code">f</code><br>
</div>
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">('a -> bool) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><pre><span id="VALfilter_s"><span class="keyword">val</span> filter_s</span> : <code class="type">('a -> bool <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">filter f st</code> keeps only value <code class="code">x</code> such that <code class="code">f x</code> is <code class="code"><span class="keyword">true</span></code><br>
</div>
<pre><span id="VALfilter_map"><span class="keyword">val</span> filter_map</span> : <code class="type">('a -> 'b option) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><pre><span id="VALfilter_map_s"><span class="keyword">val</span> filter_map_s</span> : <code class="type">('a -> 'b option <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">filter_map f st</code> filter and map <code class="code">st</code> at the same time<br>
</div>
<pre><span id="VALmap_list"><span class="keyword">val</span> map_list</span> : <code class="type">('a -> 'b list) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><pre><span id="VALmap_list_s"><span class="keyword">val</span> map_list_s</span> : <code class="type">('a -> 'b list <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">map_list f st</code> applies <code class="code">f</code> on each element of <code class="code">st</code> and flattens
the lists returned<br>
</div>
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('a -> 'b -> 'b) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALfold_s"><span class="keyword">val</span> fold_s</span> : <code class="type">('a -> 'b -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">fold f s x</code> fold_like function for streams.<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> unit) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALiter_p"><span class="keyword">val</span> iter_p</span> : <code class="type">('a -> unit <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALiter_s"><span class="keyword">val</span> iter_s</span> : <code class="type">('a -> unit <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">iter f s</code> iterates over all elements of the stream<br>
</div>
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">('a -> bool) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALfind_s"><span class="keyword">val</span> find_s</span> : <code class="type">('a -> bool <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">find f s</code> find an element in a stream.<br>
</div>
<pre><span id="VALfind_map"><span class="keyword">val</span> find_map</span> : <code class="type">('a -> 'b option) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALfind_map_s"><span class="keyword">val</span> find_map_s</span> : <code class="type">('a -> 'b option <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b option <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">find f s</code> find and map at the same time.<br>
</div>
<pre><span id="VALcombine"><span class="keyword">val</span> combine</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt_stream.html#TYPEt">t</a> -> ('a * 'b) <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">combine s1 s2</code> combine two streams. The stream will ends when
the first stream ends.<br>
</div>
<pre><span id="VALappend"><span class="keyword">val</span> append</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">append s1 s2</code> returns a stream which returns all elements of
<code class="code">s1</code>, then all elements of <code class="code">s2</code><br>
</div>
<pre><span id="VALconcat"><span class="keyword">val</span> concat</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">concat st</code> returns the concatenation of all streams of <code class="code">st</code>.<br>
</div>
<pre><span id="VALflatten"><span class="keyword">val</span> flatten</span> : <code class="type">'a list <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">flatten st = map_list (<span class="keyword">fun</span> l <span class="keywordsign">-></span> l) st</code><br>
</div>
<pre><code><span id="TYPEresult"><span class="keyword">type</span> <code class="type">'a</code> result</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresult.Value"><span class="constructor">Value</span></span> <span class="keyword">of</span> <code class="type">'a</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresult.Error"><span class="constructor">Error</span></span> <span class="keyword">of</span> <code class="type">exn</code></code></td>
</tr></table>
<div class="info">
A value or an error.<br>
</div>
<pre><span id="VALmap_exn"><span class="keyword">val</span> map_exn</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> 'a <a href="Lwt_stream.html#TYPEresult">result</a> <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">map_exn s</code> returns a stream that captures all exceptions raised
by the source of the stream (the function passed to <a href="Lwt_stream.html#VALfrom"><code class="code"><span class="constructor">Lwt_stream</span>.from</code></a>).
<p>
Note that for push-streams (as returned by <a href="Lwt_stream.html#VALcreate"><code class="code"><span class="constructor">Lwt_stream</span>.create</code></a>) all
elements of the mapped streams are values.<br>
</div>
<br>
<h6 id="6_Parsing">Parsing</h6><br>
<pre><span id="VALparse"><span class="keyword">val</span> parse</span> : <code class="type">'a <a href="Lwt_stream.html#TYPEt">t</a> -> ('a <a href="Lwt_stream.html#TYPEt">t</a> -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
<code class="code">parse st f</code> parses <code class="code">st</code> with <code class="code">f</code>. If <code class="code">f</code> raise an exception,
<code class="code">st</code> is restored to its previous state.
<p>
It raises <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">st</code> is a bounded
push-stream.<br>
</div>
<br>
<h6 id="6_Misc">Misc</h6><br>
<pre><span id="VALhexdump"><span class="keyword">val</span> hexdump</span> : <code class="type">char <a href="Lwt_stream.html#TYPEt">t</a> -> string <a href="Lwt_stream.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">hexdump byte_stream</code> returns a stream which is the same as the
output of <code class="code">hexdump -<span class="constructor">C</span></code>.
<p>
Basically, here is a simple implementation of <code class="code">hexdump -<span class="constructor">C</span></code>:
<p>
<pre class="codepre"><code class="code"> <span class="keyword">let</span> () = <span class="constructor">Lwt_main</span>.run (<span class="constructor">Lwt_io</span>.write_lines <span class="constructor">Lwt_io</span>.stdout (<span class="constructor">Lwt_stream</span>.hexdump (<span class="constructor">Lwt_io</span>.read_lines <span class="constructor">Lwt_io</span>.stdin)))<br>
</code></pre><br>
</div>
</body></html>
