File: C:/Ruby27-x64/share/doc/ruby/html/KeyError.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class KeyError - 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="IndexError.html">IndexError</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-key">#key</a>
<li ><a href="#method-i-receiver">#receiver</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-KeyError">
<h1 id="class-KeyError" class="class">
class KeyError
</h1>
<section class="description">
<p>Raised when the specified key is not found. It is a subclass of <a href="IndexError.html"><code>IndexError</code></a>.</p>
<pre class="ruby"><span class="ruby-identifier">h</span> = {<span class="ruby-string">"foo"</span> <span class="ruby-operator">=></span> <span class="ruby-value">:bar</span>}
<span class="ruby-identifier">h</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">"foo"</span>) <span class="ruby-comment">#=> :bar</span>
<span class="ruby-identifier">h</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">"baz"</span>) <span class="ruby-comment">#=> KeyError: key not found: "baz"</span>
</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(message=nil, receiver: nil, key: nil) → key_error
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Construct a new <code>KeyError</code> exception with the given message, receiver and key.</p>
<div class="method-source-code" id="new-source">
<pre>static VALUE
key_err_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE options;
rb_call_super(rb_scan_args(argc, argv, "01:", NULL, &options), argv);
if (!NIL_P(options)) {
ID keywords[2];
VALUE values[numberof(keywords)];
int i;
keywords[0] = id_receiver;
keywords[1] = id_key;
rb_get_kwargs(options, keywords, 0, numberof(values), values);
for (i = 0; i < numberof(values); ++i) {
if (values[i] != Qundef) {
rb_ivar_set(self, keywords[i], values[i]);
}
}
}
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-key" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
key → object
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the key caused this <a href="KeyError.html"><code>KeyError</code></a> exception.</p>
<div class="method-source-code" id="key-source">
<pre>static VALUE
key_err_key(VALUE self)
{
VALUE key;
key = rb_ivar_lookup(self, id_key, Qundef);
if (key != Qundef) return key;
rb_raise(rb_eArgError, "no key is available");
}</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="KeyError.html"><code>KeyError</code></a> exception.</p>
<div class="method-source-code" id="receiver-source">
<pre>static VALUE
key_err_receiver(VALUE self)
{
VALUE recv;
recv = rb_ivar_lookup(self, id_receiver, Qundef);
if (recv != Qundef) return recv;
rb_raise(rb_eArgError, "no receiver is available");
}</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>