Breaks

Scala 2.8 added the break control flow option. It is not implemented as a special language feature. Rather it is simply implemented as an object/trait using standard Scala mechanisms. If you are interested in creating a control flow object similar to this look at the Defining Custom Control Structures post.

The Break functionality is works basically how you would expect:

1. // Import the control flow methodsmethods
2. scala> import util.control.Breaks._
3. import util.control.Breaks._
5. // pass a function to the breakable method
6. scala> breakable {
7.      | for (i <- 1 to 10 ) {
8.      | if(i > 5) break  // call break when done
9.      | println(i)
10.      | }
11.      | }
12. 1
13. 2
14. 3
15. 4
16. 5

Pretty intuitive but beware, break only breaks out to the first enclosing breakable. Here is an example of the issue:

1. scala> def loop(f : Int => Boolean) = breakable {
2.      | for (i <- 1 to 300) if (f(i)) break else println(i)
3.      | }
4. loop: (f: (Int) => Boolean)Unit
6. // This never ends because break is caught by breakable in the loop method
7. scala> breakable {
8.      | while(true) {
9.      | loop{ i => break; true }
10.      | }
11.      | }

Fortunately the implementers provide an elegant way to handle these sorts of cases. The Breaks object extends the Breaks class. By instantiating other instances of Breaks it is possible to control which breaks capture

1. scala> import scala.util.control._
2. import scala.util.control._
4. scala> 
6. scala> def loop(f : Int => Boolean) = {
7.      |   val Inner = new Breaks
8.      |   Inner.breakable {
9.      |     for (i <- 1 to 4) if (f(i)) Inner.break else println(i)
10.      |   }
11.      | }
12. loop: (f: (Int) => Boolean)Unit
14. scala> 
16. scala> val Outer = new Breaks
17. Outer: scala.util.control.Breaks = scala.util.control.Breaks@1ba4806
19. scala> Outer.breakable {
20.      |   while(true) {
21.      |     loop{ i => if(i==4) Outer.break; false}
22.      |   }
23.      | }
24. 1
25. 2
26. 3