class StopIteration - Ruby 2.2.4 Core API Reference API Reference

Ruby 2.2 Core API

previous page next page

class StopIteration

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!

In Files

  • enumerator.c

Parent

IndexError

Public Instance Methods

result → value click to toggle source

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

static VALUE
stop_result(VALUE self)
{
    return rb_attr_get(self, id_result);
}
previous page start next page