mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
331 lines
No EOL
26 KiB
HTML
331 lines
No EOL
26 KiB
HTML
<!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=utf-8" http-equiv="Content-Type">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="Containers.Char.html">
|
|
<link rel="Up" href="Containers.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 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="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCPrint" rel="Chapter" href="CCPrint.html">
|
|
<link title="CCError" rel="Chapter" href="CCError.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCHashconsedSet" rel="Chapter" href="CCHashconsedSet.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCBloom" rel="Chapter" href="CCBloom.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCAllocCache" rel="Chapter" href="CCAllocCache.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="Containers_string" rel="Chapter" href="Containers_string.html">
|
|
<link title="CCKMP" rel="Chapter" href="CCKMP.html">
|
|
<link title="CCLevenshtein" rel="Chapter" href="CCLevenshtein.html">
|
|
<link title="CCApp_parse" rel="Chapter" href="CCApp_parse.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCBigstring" rel="Chapter" href="CCBigstring.html">
|
|
<link title="CCArray1" rel="Chapter" href="CCArray1.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="Containers_advanced" rel="Chapter" href="Containers_advanced.html">
|
|
<link title="CCLinq" rel="Chapter" href="CCLinq.html">
|
|
<link title="CCBatch" rel="Chapter" href="CCBatch.html">
|
|
<link title="CCCat" rel="Chapter" href="CCCat.html">
|
|
<link title="CCMonadIO" rel="Chapter" href="CCMonadIO.html">
|
|
<link title="Containers_io_is_deprecated" rel="Chapter" href="Containers_io_is_deprecated.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexpM" rel="Chapter" href="CCSexpM.html"><link title="Basics" rel="Section" href="#2_Basics">
|
|
<link title="Wrappers" rel="Section" href="#2_Wrappers">
|
|
<link title="Applicative" rel="Section" href="#2_Applicative">
|
|
<link title="Infix" rel="Section" href="#2_Infix">
|
|
<link title="Collections" rel="Section" href="#2_Collections">
|
|
<link title="Misc" rel="Section" href="#2_Misc">
|
|
<link title="Conversions" rel="Section" href="#2_Conversions">
|
|
<link title="IO" rel="Section" href="#2_IO">
|
|
<title>Containers doc : Containers.Result</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="Containers.Char.html" title="Containers.Char">Previous</a>
|
|
<a class="up" href="Containers.html" title="Containers">Up</a>
|
|
</div>
|
|
<h1>Module <a href="type_Containers.Result.html">Containers.Result</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Result: <code class="type"><a href="CCResult.html">CCResult</a></code></pre><hr width="100%">
|
|
|
|
<pre><span id="TYPEsequence"><span class="keyword">type</span> <code class="type">'a</code> sequence</span> = <code class="type">('a -> unit) -> unit</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEequal"><span class="keyword">type</span> <code class="type">'a</code> equal</span> = <code class="type">'a -> 'a -> bool</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEord"><span class="keyword">type</span> <code class="type">'a</code> ord</span> = <code class="type">'a -> 'a -> int</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEprinter"><span class="keyword">type</span> <code class="type">'a</code> printer</span> = <code class="type">Buffer.t -> 'a -> unit</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEformatter"><span class="keyword">type</span> <code class="type">'a</code> formatter</span> = <code class="type">Format.formatter -> 'a -> unit</code> </pre>
|
|
|
|
<br>
|
|
<h2 id="2_Basics">Basics</h2><br>
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">('good, 'bad)</code> t</span> = <code class="type">('good, 'bad) Result.result</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="TYPEELTt.Ok"><span class="constructor">Ok</span></span> <span class="keyword">of</span> <code class="type">'good</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="TYPEELTt.Error"><span class="constructor">Error</span></span> <span class="keyword">of</span> <code class="type">'bad</code></code></td>
|
|
|
|
</tr></table>
|
|
|
|
|
|
|
|
<pre><span id="VALreturn"><span class="keyword">val</span> return</span> : <code class="type">'a -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Successfully return a value<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfail"><span class="keyword">val</span> fail</span> : <code class="type">'err -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Fail with an error<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_exn"><span class="keyword">val</span> of_exn</span> : <code class="type">exn -> ('a, string) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">of_exn e</code> uses <code class="code"><span class="constructor">Printexc</span></code> to print the exception as a string<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_exn_trace"><span class="keyword">val</span> of_exn_trace</span> : <code class="type">exn -> ('a, string) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">of_exn_trace e</code> is similar to <code class="code">of_exn e</code>, but it adds the stacktrace
|
|
to the error message.
|
|
<p>
|
|
|
|
Remember to call <code class="code"><span class="constructor">Printexc</span>.record_backtrace <span class="keyword">true</span></code> and compile with the
|
|
debug flag for this to work.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfail_printf"><span class="keyword">val</span> fail_printf</span> : <code class="type">('a, Buffer.t, unit, ('a, string) <a href="CCResult.html#TYPEt">t</a>) Pervasives.format4 -> 'a</code></pre><div class="info ">
|
|
<code class="code">fail_printf format</code> uses <code class="code">format</code> to obtain an error message
|
|
and then returns <code class="code"><span class="constructor">Error</span> msg</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALfail_fprintf"><span class="keyword">val</span> fail_fprintf</span> : <code class="type">('a, Format.formatter, unit, ('a, string) <a href="CCResult.html#TYPEt">t</a>) Pervasives.format4 -><br> 'a</code></pre><div class="info ">
|
|
<code class="code">fail_printf format</code> uses <code class="code">format</code> to obtain an error message
|
|
and then returns <code class="code"><span class="constructor">Error</span> msg</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Map on success<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap_err"><span class="keyword">val</span> map_err</span> : <code class="type">('err1 -> 'err2) -> ('a, 'err1) <a href="CCResult.html#TYPEt">t</a> -> ('a, 'err2) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Map on the error variant<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap2"><span class="keyword">val</span> map2</span> : <code class="type">('a -> 'b) -><br> ('err1 -> 'err2) -> ('a, 'err1) <a href="CCResult.html#TYPEt">t</a> -> ('b, 'err2) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALmap"><code class="code"><span class="constructor">CCResult</span>.map</code></a>, but also with a function that can transform
|
|
the error message in case of failure<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> unit) -> ('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
|
|
Apply the function only in case of Ok<br>
|
|
</div>
|
|
|
|
<pre><span id="EXCEPTIONGet_error"><span class="keyword">exception</span> Get_error</span></pre>
|
|
|
|
<pre><span id="VALget_exn"><span class="keyword">val</span> get_exn</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Extract the value <code class="code">x</code> from <code class="code"><span class="constructor">Ok</span> x</code>, fails otherwise.
|
|
You should be careful with this function, and favor other combinators
|
|
whenever possible.<br>
|
|
<b>Raises</b> <code>Get_error</code> if the value is an error.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget_or"><span class="keyword">val</span> get_or</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> default:'a -> 'a</code></pre><div class="info ">
|
|
<code class="code">get_or e ~default</code> returns <code class="code">x</code> if <code class="code">e = <span class="constructor">Ok</span> x</code>, <code class="code">default</code> otherwise<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap_or"><span class="keyword">val</span> map_or</span> : <code class="type">('a -> 'b) -> ('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> default:'b -> 'b</code></pre><div class="info ">
|
|
<code class="code">map_or f e ~default</code> returns <code class="code">f x</code> if <code class="code">e = <span class="constructor">Ok</span> x</code>, <code class="code">default</code> otherwise<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcatch"><span class="keyword">val</span> catch</span> : <code class="type">('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ok:('a -> 'b) -> err:('err -> 'b) -> 'b</code></pre><div class="info ">
|
|
<code class="code">catch e ~ok ~err</code> calls either <code class="code">ok</code> or <code class="code">err</code> depending on
|
|
the value of <code class="code">e</code>.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALflat_map"><span class="keyword">val</span> flat_map</span> : <code class="type">('a -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a>) -><br> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VAL(>|=)"><span class="keyword">val</span> (>|=)</span> : <code class="type">('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('a -> 'b) -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VAL(>>=)"><span class="keyword">val</span> (>>=)</span> : <code class="type">('a, 'err) <a href="CCResult.html#TYPEt">t</a> -><br> ('a -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a>) -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">?err:'err <a href="CCResult.html#TYPEequal">equal</a> -><br> 'a <a href="CCResult.html#TYPEequal">equal</a> -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEequal">equal</a></code></pre>
|
|
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">?err:'err <a href="CCResult.html#TYPEord">ord</a> -><br> 'a <a href="CCResult.html#TYPEord">ord</a> -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEord">ord</a></code></pre>
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">ok:('a -> 'b) -> error:('err -> 'b) -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> 'b</code></pre><div class="info ">
|
|
<code class="code">fold ~ok ~error e</code> opens <code class="code">e</code> and, if <code class="code">e = <span class="constructor">Ok</span> x</code>, returns
|
|
<code class="code">ok x</code>, otherwise <code class="code">e = <span class="constructor">Error</span> s</code> and it returns <code class="code">error s</code>.<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_Wrappers">Wrappers</h2><br>
|
|
|
|
<pre><span id="VALguard"><span class="keyword">val</span> guard</span> : <code class="type">(unit -> 'a) -> ('a, exn) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">guard f</code> runs <code class="code">f ()</code> and returns its result wrapped in <code class="code"><span class="constructor">Ok</span></code>. If
|
|
<code class="code">f ()</code> raises some exception <code class="code">e</code>, then it fails with <code class="code"><span class="constructor">Error</span> e</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALguard_str"><span class="keyword">val</span> guard_str</span> : <code class="type">(unit -> 'a) -> ('a, string) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALguard"><code class="code"><span class="constructor">CCResult</span>.guard</code></a> but uses <a href="CCResult.html#VALof_exn"><code class="code"><span class="constructor">CCResult</span>.of_exn</code></a> to print the exception.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALguard_str_trace"><span class="keyword">val</span> guard_str_trace</span> : <code class="type">(unit -> 'a) -> ('a, string) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALguard_str"><code class="code"><span class="constructor">CCResult</span>.guard_str</code></a> but uses <a href="CCResult.html#VALof_exn_trace"><code class="code"><span class="constructor">CCResult</span>.of_exn_trace</code></a> instead of <a href="CCResult.html#VALof_exn"><code class="code"><span class="constructor">CCResult</span>.of_exn</code></a> so
|
|
that the stack trace is printed.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALwrap1"><span class="keyword">val</span> wrap1</span> : <code class="type">('a -> 'b) -> 'a -> ('b, exn) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALguard"><code class="code"><span class="constructor">CCResult</span>.guard</code></a> but gives the function one argument.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALwrap2"><span class="keyword">val</span> wrap2</span> : <code class="type">('a -> 'b -> 'c) -> 'a -> 'b -> ('c, exn) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALguard"><code class="code"><span class="constructor">CCResult</span>.guard</code></a> but gives the function two arguments.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALwrap3"><span class="keyword">val</span> wrap3</span> : <code class="type">('a -> 'b -> 'c -> 'd) -> 'a -> 'b -> 'c -> ('d, exn) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCResult.html#VALguard"><code class="code"><span class="constructor">CCResult</span>.guard</code></a> but gives the function three arguments.<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_Applicative">Applicative</h2><br>
|
|
|
|
<pre><span id="VALpure"><span class="keyword">val</span> pure</span> : <code class="type">'a -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Synonym of <a href="CCResult.html#VALreturn"><code class="code"><span class="constructor">CCResult</span>.return</code></a><br>
|
|
</div>
|
|
|
|
<pre><span id="VAL(<*>)"><span class="keyword">val</span> (<*>)</span> : <code class="type">('a -> 'b, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">a <*> b</code> evaluates <code class="code">a</code> and <code class="code">b</code>, and, in case of success, returns
|
|
<code class="code"><span class="constructor">Ok</span> (a b)</code>. Otherwise, it fails, and the error of <code class="code">a</code> is chosen
|
|
over the error of <code class="code">b</code> if both fail.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALjoin"><span class="keyword">val</span> join</span> : <code class="type">(('a, 'err) <a href="CCResult.html#TYPEt">t</a>, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">join t</code>, in case of success, returns <code class="code"><span class="constructor">Ok</span> o</code> from <code class="code"><span class="constructor">Ok</span> (<span class="constructor">Ok</span> o)</code>. Otherwise,
|
|
it fails with <code class="code"><span class="constructor">Error</span> e</code> where <code class="code">e</code> is the unwrapped error of <code class="code">t</code>.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALboth"><span class="keyword">val</span> both</span> : <code class="type">('a, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a> -> ('a * 'b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">both a b</code>, in case of success, returns <code class="code"><span class="constructor">Ok</span> (o, o')</code> with the ok values
|
|
of <code class="code">a</code> and <code class="code">b</code>. Otherwise, it fails, and the error of <code class="code">a</code> is chosen over the
|
|
error of <code class="code">b</code> if both fail.<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_Infix">Infix</h2><br>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCResult.Infix.html">Infix</a>: <code class="code"><span class="keyword">sig</span></code> <a href="CCResult.Infix.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><br>
|
|
<h2 id="2_Collections">Collections</h2><br>
|
|
|
|
<pre><span id="VALmap_l"><span class="keyword">val</span> map_l</span> : <code class="type">('a -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a>) -> 'a list -> ('b list, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALfold_l"><span class="keyword">val</span> fold_l</span> : <code class="type">('b -> 'a -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a>) -> 'b -> 'a list -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALfold_seq"><span class="keyword">val</span> fold_seq</span> : <code class="type">('b -> 'a -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a>) -><br> 'b -> 'a <a href="CCResult.html#TYPEsequence">sequence</a> -> ('b, 'err) <a href="CCResult.html#TYPEt">t</a></code></pre><br>
|
|
<h2 id="2_Misc">Misc</h2><br>
|
|
|
|
<pre><span id="VALchoose"><span class="keyword">val</span> choose</span> : <code class="type">('a, 'err) <a href="CCResult.html#TYPEt">t</a> list -> ('a, 'err list) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">choose l</code> selects a member of <code class="code">l</code> that is a <code class="code"><span class="constructor">Ok</span> _</code> value,
|
|
or returns <code class="code"><span class="constructor">Error</span> l</code> otherwise, where <code class="code">l</code> is the list of errors.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALretry"><span class="keyword">val</span> retry</span> : <code class="type">int -> (unit -> ('a, 'err) <a href="CCResult.html#TYPEt">t</a>) -> ('a, 'err list) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">retry n f</code> calls <code class="code">f</code> at most <code class="code">n</code> times, returning the first result
|
|
of <code class="code">f ()</code> that doesn't fail. If <code class="code">f</code> fails <code class="code">n</code> times, <code class="code">retry n f</code> fails
|
|
with the list of successive errors.<br>
|
|
</div>
|
|
|
|
<pre><span class="keyword">module type</span> <a href="CCResult.MONAD.html">MONAD</a> = <code class="code"><span class="keyword">sig</span></code> <a href="CCResult.MONAD.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
|
|
Monadic Operations
|
|
</div>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCResult.Traverse.html">Traverse</a> <code class="code">(</code><code class="code"><span class="constructor">M</span></code><code class="code"> : </code><code class="type"><a href="CCResult.MONAD.html">MONAD</a></code><code class="code">) </code>: <code class="code"><span class="keyword">sig</span></code> <a href="CCResult.Traverse.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><br>
|
|
<h2 id="2_Conversions">Conversions</h2><br>
|
|
|
|
<pre><span id="VALto_opt"><span class="keyword">val</span> to_opt</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> 'a option</code></pre>
|
|
<pre><span id="VALof_opt"><span class="keyword">val</span> of_opt</span> : <code class="type">'a option -> ('a, string) <a href="CCResult.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> 'a <a href="CCResult.html#TYPEsequence">sequence</a></code></pre>
|
|
<pre><span id="TYPEerror"><span class="keyword">type</span> <code class="type">('a, 'b)</code> error</span> = <code class="type">[ `Error of 'b | `Ok of 'a ]</code> </pre>
|
|
|
|
|
|
<pre><span id="VALof_err"><span class="keyword">val</span> of_err</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEerror">error</a> -> ('a, 'b) <a href="CCResult.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_err"><span class="keyword">val</span> to_err</span> : <code class="type">('a, 'b) <a href="CCResult.html#TYPEt">t</a> -> ('a, 'b) <a href="CCResult.html#TYPEerror">error</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_IO">IO</h2><br>
|
|
|
|
<pre><span id="VALpp"><span class="keyword">val</span> pp</span> : <code class="type">'a <a href="CCResult.html#TYPEprinter">printer</a> -> ('a, string) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEprinter">printer</a></code></pre>
|
|
<pre><span id="VALpp'"><span class="keyword">val</span> pp'</span> : <code class="type">'a <a href="CCResult.html#TYPEprinter">printer</a> -><br> 'e <a href="CCResult.html#TYPEprinter">printer</a> -> ('a, 'e) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEprinter">printer</a></code></pre><div class="info ">
|
|
Printer that is generic on the error type<br>
|
|
<b>Since</b> 0.19<br>
|
|
</div>
|
|
|
|
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">'a <a href="CCResult.html#TYPEformatter">formatter</a> -> ('a, string) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEformatter">formatter</a></code></pre>
|
|
<pre><span id="VALprint'"><span class="keyword">val</span> print'</span> : <code class="type">'a <a href="CCResult.html#TYPEformatter">formatter</a> -><br> 'e <a href="CCResult.html#TYPEformatter">formatter</a> -> ('a, 'e) <a href="CCResult.html#TYPEt">t</a> <a href="CCResult.html#TYPEformatter">formatter</a></code></pre><div class="info ">
|
|
Printer that is generic on the error type<br>
|
|
<b>Since</b> 0.19<br>
|
|
</div>
|
|
</body></html> |