123456789_123456789_123456789_123456789_123456789_

Exception: StopIteration

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
ClosedQueueError, Ractor::ClosedError
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::IndexError, ::StandardError, ::Exception
Instance Chain:
self, ::IndexError, ::StandardError, ::Exception
Inherits: IndexError
Defined in: enumerator.c

Overview

Raised to stop the iteration, in particular by Enumerator#next. It is rescued by Kernel.loop.

loop do
  puts "Hello"
  raise StopIteration
  puts "World"
end
puts "Done!"

produces:

Hello
Done!

Class Attribute Summary

::Exception - Inherited

.to_tty?

Returns true if exception messages will be sent to a tty.

Class Method Summary

::Exception - Inherited

.exception

With no argument, or if the argument is the same as the receiver, return the receiver.
.new

Construct a new ::Exception object, optionally passing in a message.

Instance Method Summary

::Exception - Inherited

#==

Equality—If obj is not an ::Exception, returns false.
#backtrace

Returns any backtrace associated with the exception.
#backtrace_locations

Returns any backtrace associated with the exception.
#cause

Returns the previous exception ($!) at the time this exception was raised.
#exception

With no argument, or if the argument is the same as the receiver, return the receiver.
#full_message

Returns formatted string of exception.
#inspect

Return this exception’s class name and message.
#message

Returns the result of invoking exception.to_s.
#set_backtrace

Sets the backtrace information associated with exc.
#to_s

Returns exception’s message (or the name of the exception if no message is set).

Constructor Details

This class inherits a constructor from Exception

Instance Method Details

#result ⇒ value

Returns the return value of the iterator.

o = Object.new
def o.each
  yield 1
  yield 2
  yield 3
  100
end

e = o.to_enum

puts e.next                   #=> 1
puts e.next                   #=> 2
puts e.next                   #=> 3

begin
  e.next
rescue StopIteration => ex
  puts ex.result              #=> 100
end
[ GitHub ] 

  


# File 'enumerator.c', line 2839



static VALUE
stop_result(VALUE self)
{
    return rb_attr_get(self, id_result);
}