org.scalatest.enablers

Length

trait Length[T] extends AnyRef

Supertrait for Length typeclasses.

Trait Length is a typeclass trait for objects that can be queried for length. Objects of type T for which an implicit Length[T] is available can be used with the should have length syntax. In other words, this trait enables you to use the length checking syntax with arbitrary objects. As an example, the following Bridge class:

scala> import org.scalatest._
import org.scalatest._

scala> import enablers.Length
import enablers.Length

scala> import Matchers._
import Matchers._

scala> case class Bridge(span: Int)
defined class Bridge

Out of the box you can't use the should have length syntax with Bridge, because ScalaTest doesn't know that a bridge's span means its length:

scala> val bridge = new Bridge(2000)
bridge: Bridge = Bridge(2000)

scala> bridge should have length 2000
<console>:34: error: could not find implicit value for
    parameter len: org.scalatest.enablers.Length[Bridge]
      bridge should have length 2000
                         ^

You can teach this to ScalaTest, however, by defining an implicit Length[Bridge].

scala> implicit val lengthOfBridge: Length[Bridge] =
     |   new Length[Bridge] {
     |     def lengthOf(b: Bridge): Long = b.span
     |   }
lengthOfBridge: org.scalatest.enablers.Length[Bridge] = [email protected]

With the implicit Length[Bridge] in scope, you can now use ScalaTest's should have length syntax with Bridge instances:

scala> bridge should have length 2000
res4: org.scalatest.Assertion = Succeeded

scala> bridge should have length 2001
org.scalatest.exceptions.TestFailedException: Bridge(2000) had length 2000 instead of expected length 2001
  at org.scalatest.MatchersHelper$.newTestFailedException(MatchersHelper.scala:148)
  at org.scalatest.MatchersHelper$.indicateFailure(MatchersHelper.scala:366)
  at org.scalatest.Matchers$ResultOfHaveWordForExtent.length(Matchers.scala:2720)
  ... 43 elided

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Length
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def lengthOf(obj: T): Long

    Returns the length of the passed object.

    Returns the length of the passed object.

    obj

    the object whose length to return

    returns

    the length of the passed object

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped