File: C:/Ruby27-x64/share/doc/ruby/html/OptionParser/ParseError.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OptionParser::ParseError - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../RuntimeError.html">RuntimeError</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-filter_backtrace">::filter_backtrace</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-message">#message</a>
<li ><a href="#method-i-reason">#reason</a>
<li ><a href="#method-i-recover">#recover</a>
<li class="calls-super" ><a href="#method-i-set_backtrace">#set_backtrace</a>
<li ><a href="#method-i-set_option">#set_option</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OptionParser::ParseError">
<h1 id="class-OptionParser::ParseError" class="class">
class OptionParser::ParseError
</h1>
<section class="description">
<p>Base class of exceptions from <a href="../OptionParser.html"><code>OptionParser</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="Reason">Reason
<dd><p><a href="ParseError.html#Reason"><code>Reason</code></a> which caused the error.</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-additional" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">additional</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-args" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">args</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-reason" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">reason</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-filter_backtrace" class="method-detail ">
<div class="method-heading">
<span class="method-name">filter_backtrace</span><span
class="method-args">(array)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="filter_backtrace-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2047</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">filter_backtrace</span>(<span class="ruby-identifier">array</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">$DEBUG</span>
<span class="ruby-identifier">array</span>.<span class="ruby-identifier">delete_if</span>(<span class="ruby-operator">&</span><span class="ruby-regexp">%r"\A#{Regexp.quote(__FILE__)}:"o</span>.<span class="ruby-identifier">method</span>(<span class="ruby-value">:=~</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">array</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*args, additional: nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2028</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-value">additional:</span> <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@additional</span> = <span class="ruby-identifier">additional</span>
<span class="ruby-ivar">@arg0</span>, = <span class="ruby-identifier">args</span>
<span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
<span class="ruby-ivar">@reason</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2074</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-node">"#<#{self.class}: #{args.join(' ')}>"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-message" class="method-detail ">
<div class="method-heading">
<span class="method-name">message</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Default stringizing method to emit standard error message.</p>
<div class="method-source-code" id="message-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2081</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message</span>
<span class="ruby-node">"#{reason}: #{args.join(' ')}#{additional[@arg0] if additional}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="ParseError.html#method-i-to_s">to_s</a>
</div>
</div>
<div id="method-i-reason" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns error reason. Override this for I18N.</p>
<div class="method-source-code" id="reason-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2070</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason</span>
<span class="ruby-ivar">@reason</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Reason</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-recover" class="method-detail ">
<div class="method-heading">
<span class="method-name">recover</span><span
class="method-args">(argv)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Pushes back erred argument(s) to <code>argv</code>.</p>
<div class="method-source-code" id="recover-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2042</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">recover</span>(<span class="ruby-identifier">argv</span>)
<span class="ruby-identifier">argv</span>[<span class="ruby-value">0</span>, <span class="ruby-value">0</span>] = <span class="ruby-ivar">@args</span>
<span class="ruby-identifier">argv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_backtrace" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_backtrace</span><span
class="method-args">(array)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Exception.html#method-i-set_backtrace"><code>Exception#set_backtrace</code></a>
</div>
<div class="method-source-code" id="set_backtrace-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2054</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_backtrace</span>(<span class="ruby-identifier">array</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">filter_backtrace</span>(<span class="ruby-identifier">array</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_option</span><span
class="method-args">(opt, eq)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_option-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2058</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_option</span>(<span class="ruby-identifier">opt</span>, <span class="ruby-identifier">eq</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">eq</span>
<span class="ruby-ivar">@args</span>[<span class="ruby-value">0</span>] = <span class="ruby-identifier">opt</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@args</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">opt</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="ParseError.html#method-i-message">message</a>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>