<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 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 methods" rel=Appendix href="index_methods.html"> <link title="Index of classes" rel=Appendix href="index_classes.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="Ocsigen_cache" rel="Chapter" href="Ocsigen_cache.html"> <link title="Ocsigen_lib_base" rel="Chapter" href="Ocsigen_lib_base.html"> <link title="Ocsigen_lib" rel="Chapter" href="Ocsigen_lib.html"> <link title="Ocsigen_config" rel="Chapter" href="Ocsigen_config.html"> <link title="Ocsigen_getcommandline" rel="Chapter" href="Ocsigen_getcommandline.html"> <link title="Ocsigen_messages" rel="Chapter" href="Ocsigen_messages.html"> <link title="Ocsigen_stream" rel="Chapter" href="Ocsigen_stream.html"> <link title="Ocsigen_loader" rel="Chapter" href="Ocsigen_loader.html"> <link title="Polytables" rel="Chapter" href="Polytables.html"> <link title="Http_headers" rel="Chapter" href="Http_headers.html"> <link title="Ocsigen_http_frame" rel="Chapter" href="Ocsigen_http_frame.html"> <link title="Ocsigen_headers" rel="Chapter" href="Ocsigen_headers.html"> <link title="Framepp" rel="Chapter" href="Framepp.html"> <link title="Ocsigen_http_com" rel="Chapter" href="Ocsigen_http_com.html"> <link title="Ocsigen_charset_mime" rel="Chapter" href="Ocsigen_charset_mime.html"> <link title="Ocsigen_senders" rel="Chapter" href="Ocsigen_senders.html"> <link title="Ocsigen_cookies" rel="Chapter" href="Ocsigen_cookies.html"> <link title="Ocsigen_extensions" rel="Chapter" href="Ocsigen_extensions.html"> <link title="Ocsigen_parseconfig" rel="Chapter" href="Ocsigen_parseconfig.html"> <link title="Ocsigen_http_client" rel="Chapter" href="Ocsigen_http_client.html"> <link title="Ocsigen_local_files" rel="Chapter" href="Ocsigen_local_files.html"> <link title="Ocsigen_server" rel="Chapter" href="Ocsigen_server.html"> <link title="Ocsigen_comet" rel="Chapter" href="Ocsigen_comet.html"> <link title="Accesscontrol" rel="Chapter" href="Accesscontrol.html"> <link title="Authbasic" rel="Chapter" href="Authbasic.html"> <link title="Ocsipersist" rel="Chapter" href="Ocsipersist.html"><title>Ocsigen_stream</title> </head> <body> <code class="code"><span class="keyword">sig</span><br> <span class="keyword">exception</span> <span class="constructor">Interrupted</span> <span class="keyword">of</span> exn<br> <span class="keyword">exception</span> <span class="constructor">Cancelled</span><br> <span class="keyword">exception</span> <span class="constructor">Already_read</span><br> <span class="keyword">exception</span> <span class="constructor">Finalized</span><br> <span class="keyword">type</span> <span class="keywordsign">'</span>a stream<br> <span class="keyword">type</span> <span class="keywordsign">'</span>a step = <span class="keyword">private</span><br> <span class="constructor">Finished</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.stream option<br> <span class="keywordsign">|</span> <span class="constructor">Cont</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a * <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.stream<br> <span class="keyword">type</span> <span class="keywordsign">'</span>a t<br> <span class="keyword">type</span> outcome = [ <span class="keywordsign">`</span><span class="constructor">Failure</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Success</span> ]<br> <span class="keyword">val</span> make :<br> ?finalize:(<span class="constructor">Ocsigen_stream</span>.outcome <span class="keywordsign">-></span> unit <span class="constructor">Lwt</span>.t) <span class="keywordsign">-></span><br> (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t<br> <span class="keyword">val</span> get : <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.stream<br> <span class="keyword">val</span> next : <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.stream <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> empty :<br> (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t) option <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> cont :<br> <span class="keywordsign">'</span>a <span class="keywordsign">-></span><br> (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> add_finalizer :<br> <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t <span class="keywordsign">-></span> (<span class="constructor">Ocsigen_stream</span>.outcome <span class="keywordsign">-></span> unit <span class="constructor">Lwt</span>.t) <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> finalize : <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t <span class="keywordsign">-></span> <span class="constructor">Ocsigen_stream</span>.outcome <span class="keywordsign">-></span> unit <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> cancel : <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t <span class="keywordsign">-></span> unit <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> consume : <span class="keywordsign">'</span>a <span class="constructor">Ocsigen_stream</span>.t <span class="keywordsign">-></span> unit <span class="constructor">Lwt</span>.t<br> <span class="keyword">exception</span> <span class="constructor">Stream_too_small</span><br> <span class="keyword">exception</span> <span class="constructor">Stream_error</span> <span class="keyword">of</span> string<br> <span class="keyword">exception</span> <span class="constructor">String_too_large</span><br> <span class="keyword">val</span> string_of_stream : int <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.stream <span class="keywordsign">-></span> string <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> enlarge_stream :<br> string <span class="constructor">Ocsigen_stream</span>.step <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> stream_want :<br> string <span class="constructor">Ocsigen_stream</span>.step <span class="keywordsign">-></span> int <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> current_buffer : string <span class="constructor">Ocsigen_stream</span>.step <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> skip :<br> string <span class="constructor">Ocsigen_stream</span>.step <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> substream :<br> string <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.step <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.step <span class="constructor">Lwt</span>.t<br> <span class="keyword">val</span> of_file : string <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.t<br> <span class="keyword">val</span> of_string : string <span class="keywordsign">-></span> string <span class="constructor">Ocsigen_stream</span>.t<br> <span class="keyword">module</span> <span class="constructor">StringStream</span> :<br> <span class="keyword">sig</span><br> <span class="keyword">type</span> out = string <span class="constructor">Ocsigen_stream</span>.t<br> <span class="keyword">type</span> m<br> <span class="keyword">val</span> make :<br> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m <span class="keywordsign">-></span> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.out<br> <span class="keyword">val</span> empty : <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m<br> <span class="keyword">val</span> put : string <span class="keywordsign">-></span> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m<br> <span class="keyword">val</span> concat :<br> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m <span class="keywordsign">-></span><br> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m <span class="keywordsign">-></span> <span class="constructor">Ocsigen_stream</span>.<span class="constructor">StringStream</span>.m<br> <span class="keyword">end</span><br> <span class="keyword">end</span></code></body></html>
