CINXE.COM

<!DOCTYPE html> <html> <head> <meta http-equiv="content-type" content="text/html;charset=utf-8" /> <title>Scalactic</title> <link rel="Stylesheet" href="/assets/stylesheets/main.css" type="text/css" media="screen"/>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-19BZD1XMRV"></script> <script defer src='/assets/javascripts/gtag.js'></script> </head> <body> <div class="Container">  <script id="adsArtimaScript" type="text/javascript" src="https://www.artima.com/assets/javascripts/4ca150665e51d0b1c3890ca1b891c507-ads.js?product=Scalactic"></script> <div id="Header"> <div id="Nav"> <a href="/">Home</a> | <a href="/quick_start">Quick Start</a> | <a href="/install">Install</a> | <a href="/user_guide">User Guide</a> | <span><em>Scaladoc</em></span> | <a href="/supersafe">SuperSafe</a> | <a href="/about">About</a> </div>  </div>  <div id="body"> <div class="message"> <a class="scalatestLogo" href="./"> <img src="/assets/images/scalacticLogo.gif" width="400" height="60" alt="ScalaTest"/> </a> </div> <div style="text-align: left"> <h1>Scalactic's Scaladoc documentation</h1> <p> Scalactic is released as part of the <a href="http://www.scalatest.org/">ScalaTest</a> project. For every release of ScalaTest, there is a corresponding release of Scalactic with the same version number. Thus if you use both Scalactic and ScalaTest, you should make sure the version numbers match. </p> <p> Prior to 3.0.0, Scalactic Scaladoc documentation was integrated with ScalaTest's documentation. The links on this page prior to version 3.0.0 link to the Scalactic portion of ScalaTest's Scaladoc documentation: </p> <ul> <li><a href="/scaladoc/3.2.19/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.19</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.5.0+)</li> <li><a href="/scaladoc/3.2.18/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.18</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.9+)</li> <li><a href="/scaladoc/3.2.17/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.17</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.9+)</li> <li><a href="/scaladoc/3.2.16/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.16</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.9+)</li> <li><a href="/scaladoc/3.2.15/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.15</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.9+)</li> <li><a href="/scaladoc/3.2.14/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.14</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.5+)</li> <li><a href="/scaladoc/3.2.13/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.13</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.5+)</li> <li><a href="/scaladoc/3.2.12/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.12</a> (the latest release for Scala 3.1.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.8.0+, and for ScalaNative 0.4.4+)</li> <li><a href="/scaladoc/3.2.11/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.11</a> (the latest release for Scala 3.0.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.7.0+, and for ScalaNative 0.4.3+)</li> <li><a href="/scaladoc/3.2.10/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.10</a> (the latest release for Scala 3.0.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.7.0+, and for ScalaNative 0.4.0+)</li> <li><a href="/scaladoc/3.2.9/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.9</a> (the latest release for Scala 3.0.0+, 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.5.0+, and for ScalaNative 0.4.0+)</li> <li><a href="/scaladoc/3.2.8/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.8</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.5.0+, for ScalaNative 0.4.0+, and Dotty/Scala 3.0.0-RC3)</li> <li><a href="/scaladoc/3.2.7/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.7</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.5.0+, for ScalaNative 0.4.0+, and Dotty/Scala 3.0.0-RC2)</li> <li><a href="/scaladoc/3.2.6/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.6</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.3.0+, for ScalaNative 0.4.0+, and Dotty/Scala 3.0.0-RC1)</li> <li><a href="/scaladoc/3.2.5/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.5</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.3.0+, for ScalaNative 0.4.0+, and Dotty/Scala 3.0.0-RC1)</li> <li><a href="/scaladoc/3.2.4/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.4</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.3.0+, for ScalaNative 0.4.0+, and Dotty/Scala 3.0.0-RC1)</li> <li><a href="/scaladoc/3.2.3/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.3</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.3.0+, for ScalaNative 0.4.0-M2, and Dotty/Scala 3.0.0-M1)</li> <li><a href="/scaladoc/3.2.2/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.2</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.1.1, for ScalaNative 0.4.0-M2, and Dotty 0.26 and 0.27)</li> <li><a href="/scaladoc/3.2.1/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.1</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.1.1, for ScalaNative 0.4.0-M2, and Dotty 0.26)</li> <li><a href="/scaladoc/3.2.0/org/scalactic/Or.html">Scaladoc for Scalactic 3.2.0</a> (the latest release for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.0.0, for ScalaNative 0.4.0-M2, and Dotty 0.23)</li> <li><a href="/scaladoc/3.1.4/org/scalactic/Or.html">Scaladoc for Scalactic 3.1.4</a> (for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.1.1, for ScalaNative 0.4.0-M2, and Dotty 0.26)</li> <li><a href="/scaladoc/3.1.3/org/scalactic/Or.html">Scaladoc for Scalactic 3.1.3</a> (for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.1.1, for ScalaNative 0.4.0-M2, and Dotty 0.26)</li> <li><a href="/scaladoc/3.1.2/org/scalactic/Or.html">Scaladoc for Scalactic 3.1.2</a> (for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.0.0, for ScalaNative 0.4.0-M2, and Dotty 0.23)</li> <li><a href="/scaladoc/3.1.1/org/scalactic/Or.html">Scaladoc for Scalactic 3.1.1</a> (for Scala 2.13.0+, 2.12.0+, 2.11.0+, 2.10.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.0.0, for ScalaNative 0.4.0-M2, and Dotty 0.22)</li> <li><a href="/scaladoc/3.1.0/org/scalactic/Or.html">Scaladoc for Scalactic 3.1.0</a> (for Scala 2.12.0+, 2.11.0+, 2.10.0+, and 2.13.0+; on the JVM 1.8+, on Scala.js 0.6.0+ and 1.0.0-M8, for ScalaNative 0.4.0-M2, and Dotty 0.17)</li> <li><a href="/scaladoc/3.0.9/org/scalactic/Or.html">Scaladoc for Scalactic 3.0.9</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0+, both on the JVM and on Scala.js 0.6.0+, 1.0.0-M3 and 1.0.0-M8)</li> <li><a href="/scaladoc/3.0.8/org/scalactic/Or.html">Scaladoc for Scalactic 3.0.8</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0+, both on the JVM and on Scala.js 0.6.0+, 1.0.0-M3 and 1.0.0-M8)</li> <li><a href="/scaladoc/3.0.7/org/scalactic/Or.html">Scaladoc for Scalactic 3.0.7</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0-M5, both on the JVM and on Scala.js 0.6.0+ and 1.0.0-M3)</li> <li><a href="/scaladoc/3.0.6/org/scalactic/Or.html">Scaladoc for Scalactic 3.0.6</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0-M5, both on the JVM and on Scala.js 0.6.0+ and 1.0.0-M3)</li> <li><a href="/scaladoc/3.0.5/org/scalactic/Or.html">Scaladoc for Scalactic 3.0.5</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0-M2, both on the JVM and on Scala.js 0.6.0+)</li> <li><a href="/scaladoc/3.0.4/index.html#org.scalactic.Or">Scaladoc for Scalactic 3.0.4</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0-M2, both on the JVM and on Scala.js 0.6.0+)</li> <li><a href="/scaladoc/3.0.3/index.html#org.scalactic.Or">Scaladoc for Scalactic 3.0.3</a> (for Scala 2.11.0+, 2.10.0+, 2.12.0+ and 2.13.0-M1, both on the JVM and on Scala.js 0.6.0+)</li> <li><a href="/scaladoc/3.0.2/index.html#org.scalactic.Or">Scaladoc for Scalactic 3.0.2</a> (for Scala 2.11.0+, 2.10.0+, and 2.12.0+, both on the JVM and on Scala.js 0.6.13)</li> <li><a href="/scaladoc/3.0.1/index.html#org.scalactic.Or">Scaladoc for Scalactic 3.0.1</a> (for Scala 2.11.0+, 2.10.0+, and 2.12.0+, both on the JVM and on Scala.js 0.6.13)</li> <li><a href="/scaladoc/3.0.0/index.html#org.scalactic.Or">Scaladoc for Scalactic 3.0.0</a> (for Scala 2.11.0+, 2.10.0+, and 2.12.0+, both on the JVM and on Scala.js 0.6.11)</li> <li><a href="https://www.scalatest.org/scaladoc/2.2.6/index.html#org.scalactic.Or">Scaladoc for Scalactic 2.2.6</a> (for Scala 2.11.0+ and 2.10.0+)</li> <li><a href="https://www.scalatest.org/scaladoc/2.2.4/index.html#org.scalactic.package">Scaladoc for Scalactic 2.2.4</a> (for Scala 2.11.0+ and 2.10.0+)</li> <li><a href="https://www.scalatest.org/scaladoc/2.2.2/index.html#org.scalactic.package">Scaladoc for Scalactic 2.2.2</a> (for Scala 2.11.0+ and 2.10.0+)</li> <li><a href="https://www.scalatest.org/scaladoc/2.2.1/index.html#org.scalactic.package">Scaladoc for Scalactic 2.2.1</a> (for Scala 2.11.0+ and 2.10.0+)</li> <li><a href="https://www.scalatest.org/scaladoc/2.2.0/index.html#org.scalactic.package">Scaladoc for Scalactic 2.2.0</a> (for Scala 2.11.0+ and 2.10.0+)</li> </ul> </div> </div>  <div style="font-size: 66%; margin-top: 60px"> <p> Scalactic is brought to you by Bill Venners, with contributions from several other folks. It is sponsored by Artima, Inc.<br /> ScalaTest is free, open-source software released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0 license</a>. </p> <p> Copyright © 2009-2025 Artima, Inc. All Rights Reserved. </p> <p> <a href="http://www.artima.com" class="no_link_hover"> <img src="/assets/images/artima100Black.png" style="margin-top: 2px" width="100" height="38" alt="artima"/> </a> </p> </div>  </div>  </body> </html>