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,
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 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 the backtrace (the list of code locations that led to the exception), as an array of strings.
#backtrace_locations

Returns the backtrace (the list of code locations that led to the exception), as an array of ::Thread::Backtrace::Location instances.
#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

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 2905



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