<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Mangrove::Option
— Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Mangrove::Option";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (O)</a> »
<span class='title'><span class='object_link'><a href="../Mangrove.html" title="Mangrove (module)">Mangrove</a></span></span>
»
<span class="title">Option</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Mangrove::Option
<span class="abstract note title">Abstract</span>
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>T::Generic, T::Helpers, T::Sig</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Kernel</dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Option/None.html" title="Mangrove::Option::None (class)">None</a></span>, <span class='object_link'><a href="Option/Some.html" title="Mangrove::Option::Some (class)">Some</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/mangrove/option.rb<span class="defines">,<br />
lib/mangrove/option/control_signal.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This module is abstract.</strong>
<div class='inline'>
<p>Subclasses must implement the ‘abstract` methods below.</p>
</div>
</div>
<p>Option is a type that represents either some value (‘Some`) or no value (`None`).</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Option/ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span>, <span class='object_link'><a href="Option/None.html" title="Mangrove::Option::None (class)">None</a></span>, <span class='object_link'><a href="Option/Some.html" title="Mangrove::Option::Some (class)">Some</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="InnerType-constant" class="">InnerType =
</dt>
<dd><pre class="code"><span class='id identifier rubyid_type_member'>type_member</span></pre></dd>
</dl>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Boolean </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expect!-instance_method" title="#expect! (instance method)">#<strong>expect!</strong>(message) ⇒ InnerType </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expect_with!-instance_method" title="#expect_with! (instance method)">#<strong>expect_with!</strong>(&block) ⇒ InnerType </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#map_none-instance_method" title="#map_none (instance method)">#<strong>map_none</strong>(&block) ⇒ Option[InnerType] </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#map_some-instance_method" title="#map_some (instance method)">#<strong>map_some</strong>(&block) ⇒ Option[InnerType] </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#none%3F-instance_method" title="#none? (instance method)">#<strong>none?</strong> ⇒ Boolean </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#some%3F-instance_method" title="#some? (instance method)">#<strong>some?</strong> ⇒ Boolean </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#transpose-instance_method" title="#transpose (instance method)">#<strong>transpose</strong>(err) ⇒ Mangrove::Result[InnerType, T.type_parameter(:ErrType)] </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unwrap!-instance_method" title="#unwrap! (instance method)">#<strong>unwrap!</strong> ⇒ InnerType </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unwrap_or-instance_method" title="#unwrap_or (instance method)">#<strong>unwrap_or</strong>(default) ⇒ InnerType </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="==-instance_method">
#<strong>==</strong>(other) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt>BasicObject</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
167</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 167</span>
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="expect!-instance_method">
#<strong>expect!</strong>(message) ⇒ <tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
176</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 176</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expect!'>expect!</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="expect_with!-instance_method">
#<strong>expect_with!</strong>(&block) ⇒ <tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>T.proc.returns(T.untyped)</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
179</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 179</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expect_with!'>expect_with!</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="map_none-instance_method">
#<strong>map_none</strong>(&block) ⇒ <tt><span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>]</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>T.proc.returns(<span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>])</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>]</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
191</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 191</span>
<span class='kw'>def</span> <span class='id identifier rubyid_map_none'>map_none</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="map_some-instance_method">
#<strong>map_some</strong>(&block) ⇒ <tt><span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>]</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>T.proc.params(inner: <span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>).returns(<span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>])</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Mangrove::Option (module)">Option</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>]</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
188</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 188</span>
<span class='kw'>def</span> <span class='id identifier rubyid_map_some'>map_some</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="none?-instance_method">
#<strong>none?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
185</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 185</span>
<span class='kw'>def</span> <span class='id identifier rubyid_none?'>none?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="some?-instance_method">
#<strong>some?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
182</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 182</span>
<span class='kw'>def</span> <span class='id identifier rubyid_some?'>some?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="transpose-instance_method">
#<strong>transpose</strong>(err) ⇒ <tt><span class='object_link'><a href="Result.html" title="Mangrove::Result (module)">Mangrove::Result</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>, T.type_parameter(:ErrType)]</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>err</span>
<span class='type'>(<tt>T.type_parameter(:ErrType)</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Result.html" title="Mangrove::Result (module)">Mangrove::Result</a></span>[<span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span>, T.type_parameter(:ErrType)]</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
194</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 194</span>
<span class='kw'>def</span> <span class='id identifier rubyid_transpose'>transpose</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unwrap!-instance_method">
#<strong>unwrap!</strong> ⇒ <tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 173</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unwrap!'>unwrap!</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unwrap_or-instance_method">
#<strong>unwrap_or</strong>(default) ⇒ <tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>default</span>
<span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::InnerType (constant)">InnerType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
170</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 170</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unwrap_or'>unwrap_or</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Oct 24 12:49:57 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.1.2).
</div>
</div>
</body>
</html>