scalatestCoreDotty/org.scalatest/Succeeded

Succeeded

case object Succeeded extends Outcome with Assertion

Outcome for a test that succeeded.

Note: the difference between this Succeeded object and the similarly named SucceededStatus object is that this object indicates one test (or assertion) succeeded, whereas the SucceededStatus object indicates the absence of any failed tests or aborted suites during a run. Both are used as the result type of Suite lifecycle methods, but Succeeded is a possible result of withFixture, whereas SucceededStatus is a possible result of run, runNestedSuites, runTests, or runTest. In short, Succeeded is always just about one test (or assertion), whereas SucceededStatus could be about something larger: multiple tests or an entire suite.

trait Singleton
trait Product
trait Mirror
trait Assertion
class Outcome
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Type members

Inherited types

type MirroredElemLabels = EmptyTuple
Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple
Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror
type MirroredMonoType = Singleton
Inherited from:
Singleton
type MirroredType = Singleton
Inherited from:
Singleton

Value members

Concrete methods

def toSucceeded: Succeeded.type

Converts this Outcome to a Succeeded.

Converts this Outcome to a Succeeded.

Returns:

This Succeeded instance.

Inherited methods

def fromProduct(p: Product): MirroredMonoType
Inherited from:
Singleton
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def toOption: Option[Throwable]

Converts this Outcome to an Option[Throwable].

Converts this Outcome to an Option[Throwable].

This class's implementation of this method always returns None.

Returns:

a Some wrapping the contained exception if this Outcome is an instance of either Failed or Canceled.

Inherited from:
Outcome

Concrete fields

override val isSucceeded: Boolean

Indicates that this Outcome represents a test that succeeded.

Indicates that this Outcome represents a test that succeeded.

This class's implementation of this method always returns true.

Returns:

true

Inherited fields

val isCanceled: Boolean

Indicates whether this Outcome represents a test that was canceled.

Indicates whether this Outcome represents a test that was canceled.

This class's implementation of this method always returns false.

Returns:

true if this Outcome is an instance of Canceled.

Inherited from:
Outcome
val isExceptional: Boolean

Indicates whether this Outcome represents a test that either failed or was canceled, in which case this Outcome will contain an exception.

Indicates whether this Outcome represents a test that either failed or was canceled, in which case this Outcome will contain an exception.

Returns:

true if this Outcome is an instance of either Failed or Canceled.

Inherited from:
Outcome
val isFailed: Boolean

Indicates whether this Outcome represents a test that failed.

Indicates whether this Outcome represents a test that failed.

This class's implementation of this method always returns false.

Returns:

true if this Outcome is an instance of Failed.

Inherited from:
Outcome
val isPending: Boolean

Indicates whether this Outcome represents a test that was pending.

Indicates whether this Outcome represents a test that was pending.

This class's implementation of this method always returns false.

Returns:

true if this Outcome is an instance of Pending.

Inherited from:
Outcome