Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • trait CompleteLastly extends AnyRef

    Trait that provides a complete-lastly construct, which ensures cleanup code in lastly is executed whether the code passed to complete completes abruptly with an exception or successfully results in a Future, FutureOutcome, or other type with an implicit Futuristic instance.

    Trait that provides a complete-lastly construct, which ensures cleanup code in lastly is executed whether the code passed to complete completes abruptly with an exception or successfully results in a Future, FutureOutcome, or other type with an implicit Futuristic instance.

    This trait is mixed into ScalaTest's async testing styles, to make it easy to ensure cleanup code will execute whether code that produces a "futuristic" value (any type F for which a Futuristic[F] instance is implicitly available). ScalaTest provides implicit Futuristic instances for Future[T] for any type T and FutureOutcome.

    If the future-producing code passed to complete throws an exception, the cleanup code passed to lastly will be executed immediately, and the same exception will be rethrown, unless the code passed to lastly also completes abruptly with an exception. In that case, complete-lastly will complete abruptly with the exception thrown by the code passed to lastly (this mimics the behavior of finally).

    Otherwise, if the code passed to complete successfully returns a Future (or other "futuristic" type), complete-lastly will register the cleanup code to be performed once the future completes and return a new future that will complete once the original future completes and the subsequent cleanup code has completed execution. The future returned by complete-lastly will have the same result as the original future passed to complete, unless the cleanup code throws an exception. If the cleanup code passed to lastly throws an exception, the future returned by lastly will fail with that exception.

    The complete-lastly syntax is intended to be used to ensure cleanup code is executed in async testing styles like try-finally is used in traditional testing styles. Here's an example of complete-lastly used in withFixture in an async testing style:

    // Your implementation
override def withFixture(test: NoArgAsyncTest) = {

      // Perform setup here

      complete {
    super.withFixture(test) // Invoke the test function
  } lastly {
    // Perform cleanup here
  }
}

    Definition Classes
    scalatest
  • ResultOfCompleteInvocation
c

org.scalatest.CompleteLastly

ResultOfCompleteInvocation

class ResultOfCompleteInvocation[T] extends AnyRef

Class that provides the lastly method of the complete-lastly syntax.

Source
CompleteLastly.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResultOfCompleteInvocation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ResultOfCompleteInvocation(futuristicBlock: => T, futuristic: Futuristic[T])

    futuristicBlock

    a by-name that produces a futuristic type

    futuristic

    the futuristic typeclass instance

Value Members

  1. def lastly(lastlyBlock: => Unit): T

    Registers cleanup code to be executed immediately if the future-producing code passed to complete throws an exception, or otherwise asynchronously, when the future returned by the code passed to complete itself completes.

    Registers cleanup code to be executed immediately if the future-producing code passed to complete throws an exception, or otherwise asynchronously, when the future returned by the code passed to complete itself completes.

    See the main documentation for trait CompleteLastly for more detail.

    lastlyBlock

    cleanup code to execute whether the code passed to complete throws an exception or succesfully returns a futuristic value.

  2. def toString(): String

    Pretty string representation of this class.

    Pretty string representation of this class.

    Definition Classes
    ResultOfCompleteInvocation → AnyRef → Any