File: C:/Ruby27-x64/share/doc/ruby/html/NameError.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class NameError - 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="StandardError.html">StandardError</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-new">::new</a>
<li ><a href="#method-i-local_variables">#local_variables</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-receiver">#receiver</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-NameError">
<h1 id="class-NameError" class="class">
class NameError
</h1>
<section class="description">
<p>Raised when a given name is invalid or undefined.</p>
<pre class="ruby"><span class="ruby-identifier">puts</span> <span class="ruby-identifier">foo</span>
</pre>
<p><em>raises the exception:</em></p>
<pre>NameError: undefined local variable or method `foo' for main:Object</pre>
<p>Since constant names must start with a capital:</p>
<pre class="ruby"><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">const_set</span> <span class="ruby-value">:answer</span>, <span class="ruby-value">42</span>
</pre>
<p><em>raises the exception:</em></p>
<pre>NameError: wrong constant name answer</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
new(msg=nil, name=nil, receiver: nil) → name_error
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Construct a new <a href="NameError.html"><code>NameError</code></a> exception. If given the <em>name</em> parameter may subsequently be examined using the <a href="NameError.html#method-i-name"><code>NameError#name</code></a> method. <em>receiver</em> parameter allows to pass object in context of which the error happened. Example:</p>
<pre class="ruby">[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">method</span>(<span class="ruby-value">:rject</span>) <span class="ruby-comment"># NameError with name "rject" and receiver: Array</span>
[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">singleton_method</span>(<span class="ruby-value">:rject</span>) <span class="ruby-comment"># NameError with name "rject" and receiver: [1, 2, 3]</span>
</pre>
<div class="method-source-code" id="new-source">
<pre>static VALUE
name_err_initialize(int argc, VALUE *argv, VALUE self)
{
ID keywords[1];
VALUE values[numberof(keywords)], name, options;
argc = rb_scan_args(argc, argv, "*:", NULL, &options);
keywords[0] = id_receiver;
rb_get_kwargs(options, keywords, 0, numberof(values), values);
name = (argc > 1) ? argv[--argc] : Qnil;
rb_call_super(argc, argv);
name_err_init_attr(self, values[0], name);
return self;
}</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-local_variables" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
local_variables → array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a list of the local variable names defined where this <a href="NameError.html"><code>NameError</code></a> exception was raised.</p>
<p>Internal use only.</p>
<div class="method-source-code" id="local_variables-source">
<pre>static VALUE
name_err_local_variables(VALUE self)
{
VALUE vars = rb_attr_get(self, id_local_variables);
if (NIL_P(vars)) {
VALUE iseqw = rb_attr_get(self, id_iseq);
if (!NIL_P(iseqw)) vars = rb_iseqw_local_variables(iseqw);
if (NIL_P(vars)) vars = rb_ary_new();
rb_ivar_set(self, id_local_variables, vars);
}
return vars;
}</pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
name → string or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the name associated with this <a href="NameError.html"><code>NameError</code></a> exception.</p>
<div class="method-source-code" id="name-source">
<pre>static VALUE
name_err_name(VALUE self)
{
return rb_attr_get(self, id_name);
}</pre>
</div>
</div>
</div>
<div id="method-i-receiver" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
receiver → object
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the receiver associated with this <a href="NameError.html"><code>NameError</code></a> exception.</p>
<div class="method-source-code" id="receiver-source">
<pre>static VALUE
name_err_receiver(VALUE self)
{
VALUE *ptr, recv, mesg;
recv = rb_ivar_lookup(self, id_recv, Qundef);
if (recv != Qundef) return recv;
mesg = rb_attr_get(self, id_mesg);
if (!rb_typeddata_is_kind_of(mesg, &name_err_mesg_data_type)) {
rb_raise(rb_eArgError, "no receiver is available");
}
ptr = DATA_PTR(mesg);
return ptr[NAME_ERR_MESG__RECV];
}</pre>
</div>
</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>