Exception: KeyError
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
|
|
Instance Chain:
|
|
Inherits: |
IndexError
|
Defined in: | error.c, error.c |
Overview
Raised when the specified key is not found. It is a subclass of ::IndexError
.
h = {"foo" => : }
h.fetch("foo") #=> :bar
h.fetch("baz") #=> KeyError: key not found: "baz"
Class Attribute Summary
::Exception
- Inherited
.to_tty? | Returns |
Class Method Summary
-
.new(message = nil, receiver: nil, key: nil) ⇒ key_error
constructor
Construct a new
KeyError
exception with the given message, receiver and key.
::Exception
- Inherited
.exception | Returns an exception object of the same class as |
.new | Returns a new exception object. |
Instance Method Summary
-
#key ⇒ Object
Return the key caused this
KeyError
exception. -
#receiver ⇒ Object
Return the receiver associated with this
KeyError
exception.
::Exception
- Inherited
#== | Returns whether |
#backtrace | Returns a backtrace value for |
#backtrace_locations | Returns a backtrace value for |
#cause | Returns the previous value of global variable |
#detailed_message | Returns the message string with enhancements: |
#exception | Returns an exception object of the same class as |
#full_message | Returns an enhanced message string: |
#inspect | Returns a string representation of |
#message | Returns |
#set_backtrace | Sets the backtrace value for |
#to_s | Returns a string representation of |
Constructor Details
.new(message = nil, receiver: nil, key: nil) ⇒ key_error
Construct a new KeyError
exception with the given message, receiver and key.
# File 'error.c', line 2714
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 (!UNDEF_P(values[i])) { rb_ivar_set(self, keywords[i], values[i]); } } } return self; }
Instance Method Details
#key ⇒ Object
Return the key caused this KeyError
exception.
# File 'error.c', line 2685
static VALUE key_err_key(VALUE self) { VALUE key; key = rb_ivar_lookup(self, id_key, Qundef); if (!UNDEF_P(key)) return key; rb_raise(rb_eArgError, "no key is available"); }
#receiver ⇒ Object
Return the receiver associated with this KeyError
exception.
# File 'error.c', line 2668
static VALUE key_err_receiver(VALUE self) { VALUE recv; recv = rb_ivar_lookup(self, id_receiver, Qundef); if (!UNDEF_P(recv)) return recv; rb_raise(rb_eArgError, "no receiver is available"); }