123456789_123456789_123456789_123456789_123456789_

Exception: FrozenError

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: RuntimeError
Defined in: error.c,
error.c

Overview

Raised when there is an attempt to modify a frozen object.

[1, 2, 3].freeze << 4

raises the exception:

FrozenError: can't modify frozen Array

Class Attribute Summary

::Exception - Inherited

.to_tty?

Returns true if exception messages will be sent to a terminal device.

Class Method Summary

::Exception - Inherited

.exception

Returns an exception object of the same class as self; useful for creating a similar exception, but with a different message.

.new

Returns a new exception object.

Instance Method Summary

::Exception - Inherited

#==

Returns whether object is the same class as self and its #message and #backtrace are equal to those of self.

#backtrace

Returns a backtrace value for self; the returned value depends on the form of the stored backtrace value:

#backtrace_locations

Returns a backtrace value for self; the returned value depends on the form of the stored backtrace value:

#cause

Returns the previous value of global variable $!, which may be nil (see Global Variables):

#detailed_message

Returns the message string with enhancements:

#exception

Returns an exception object of the same class as self; useful for creating a similar exception, but with a different message.

#full_message

Returns an enhanced message string:

#inspect

Returns a string representation of self:

#message

Returns #to_s.

#set_backtrace

Sets the backtrace value for self; returns the given +value:

#to_s

Returns a string representation of self:

Constructor Details

.new(msg = nil, receiver: nil) ⇒ frozen_error

Construct a new FrozenError exception. If given the receiver parameter may subsequently be examined using the #receiver method.

a = [].freeze
raise FrozenError.new("can't modify frozen array", receiver: a)
[ GitHub ]

  
# File 'error.c', line 2190

static VALUE
frozen_err_initialize(int argc, VALUE *argv, VALUE self)
{
    ID keywords[1];
    VALUE values[numberof(keywords)], options;

    argc = rb_scan_args(argc, argv, "*:", NULL, &options);
    keywords[0] = id_receiver;
    rb_get_kwargs(options, keywords, 0, numberof(values), values);
    rb_call_super(argc, argv);
    err_init_recv(self, values[0]);
    return self;
}

Instance Method Details

#receiverObject

Return the receiver associated with this FrozenError exception.

[ GitHub ]