TestFailedDueToTimeoutException
Subclass of TestFailedException
representing tests that failed because of a timeout.
This exception is thrown by the failAfter
method of trait Timeouts
, the eventually
method of trait
Eventually
, and the await
methods of trait
AsyncAssertions
.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisTestFailedDueToTimeoutException
to be thrown.- messageFun
a function that produces an optional detail message for this
TestFailedDueToTimeoutException
.- posOrStackDepthFun
either a source position or a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
- timeout
the timeout that expired
- Throws:
- NullArgumentException
if either
messageFun
,cause
orfailedCodeStackDepthFun
isnull
, orSome(null)
.
Value members
Constructors
Constructs a TestFailedDueToTimeoutException
with the given error message function, optional cause, source position and optional payload.
Constructs a TestFailedDueToTimeoutException
with the given error message function, optional cause, source position and optional payload.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisTestCanceledException
to be thrown.- messageFun
a function that return an optional detail message for this
TestCanceledException
.- payload
an optional payload, which ScalaTest will include in a resulting
TestCanceled
event- pos
a source position
Constructs a TestFailedDueToTimeoutException
with the given error message function, optional cause, stack depth function, optional payload and timeout.
Constructs a TestFailedDueToTimeoutException
with the given error message function, optional cause, stack depth function, optional payload and timeout.
- Value parameters:
- cause
an optional cause, the
Throwable
that caused thisTestFailedDueToTimeoutException
to be thrown.- failedCodeStackDepthFun
a function that return the depth in the stack trace of this exception at which the line of test code that failed resides.
- messageFun
a function that return an optional detail message for this
TestFailedDueToTimeoutException
.- payload
an optional payload, which ScalaTest will include in a resulting
TestCanceled
event- timeout
the timeout that expired
Concrete methods
Returns an instance of this exception's class, identical to this exception,
except with the detail message option string replaced with the result of passing
the current detail message to the passed function, fun
.
Returns an instance of this exception's class, identical to this exception,
except with the detail message option string replaced with the result of passing
the current detail message to the passed function, fun
.
- Value parameters:
- fun
A function that, given the current optional detail message, will produce the modified optional detail message for the result instance of
TestFailedDueToTimeoutException
.
- Definition Classes
Returns an instance of this exception's class, identical to this exception,
except with the payload option replaced with the result of passing
the current payload option to the passed function, fun
.
Returns an instance of this exception's class, identical to this exception,
except with the payload option replaced with the result of passing
the current payload option to the passed function, fun
.
- Value parameters:
- fun
A function that, given the current optional payload, will produce the modified optional payload for the result instance of
TestFailedDueToTimeoutException
.
- Definition Classes
Inherited methods
Indicates whether this object can be equal to the passed object.
Indicates whether this object can be equal to the passed object.
- Definition Classes
- Inherited from:
- TestFailedException
Indicates whether this object is equal to the passed object. If the passed object is
a TestFailedException
, equality requires equal message
,
cause
, and failedCodeStackDepth
fields, as well as equal
return values of getStackTrace
.
Indicates whether this object is equal to the passed object. If the passed object is
a TestFailedException
, equality requires equal message
,
cause
, and failedCodeStackDepth
fields, as well as equal
return values of getStackTrace
.
- Definition Classes
- Inherited from:
- TestFailedException
A string that provides the filename of the line of code that failed, suitable
for presenting to a user, which is taken from this exception's StackTraceElement
at the depth specified
by failedCodeStackDepth
.
A string that provides the filename of the line of code that failed, suitable
for presenting to a user, which is taken from this exception's StackTraceElement
at the depth specified
by failedCodeStackDepth
.
This is a def
instead of a val
because exceptions are mutable: their stack trace can
be changed after the exception is created. This is done, for example, by the SeveredStackTraces
trait.
- Returns:
a string containing the filename that caused the failed test
- Inherited from:
- StackDepth
A string that provides the filename and line number of the line of code that failed, suitable
for presenting to a user of the failing line. It calls failedCodeFileName
and
failedCodeLineNumber
to get the failing filename and line number.
A string that provides the filename and line number of the line of code that failed, suitable
for presenting to a user of the failing line. It calls failedCodeFileName
and
failedCodeLineNumber
to get the failing filename and line number.
failedCodeFileName
and failedCodeLineNumber
will fall back to exception stack trace
when Position
is not avaiable, this is the reason it is a def
instead of a val
,
because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example,
by the SeveredStackTraces
trait.
- Returns:
a user-presentable string containing the filename and line number that caused the failed test
- Inherited from:
- StackDepth
A string that provides the line number of the line of code that failed, suitable
for presenting to a user, which is taken from this exception's StackTraceElement
at the depth specified
by failedCodeStackDepth
.
A string that provides the line number of the line of code that failed, suitable
for presenting to a user, which is taken from this exception's StackTraceElement
at the depth specified
by failedCodeStackDepth
.
This is a def
instead of a val
because exceptions are mutable: their stack trace can
be changed after the exception is created. This is done, for example, by the SeveredStackTraces
trait.
- Returns:
a string containing the line number that caused the failed test
- Inherited from:
- StackDepth
Returns the detail message string of this StackDepthException
.
Returns the detail message string of this StackDepthException
.
- Returns:
the detail message string of this
StackDepthException
instance (which may benull
).- Definition Classes
- StackDepthException -> Throwable
- Inherited from:
- StackDepthException
Returns a hash code value for this object.
Returns a hash code value for this object.
- Definition Classes
- Inherited from:
- TestFailedException
Returns an exception of class TestFailedException
with failedExceptionStackDepth
set to 0 and
all frames above this stack depth severed off. This can be useful when working with tools (such as IDEs) that do not
directly support ScalaTest. (Tools that directly support ScalaTest can use the stack depth information delivered
in the StackDepth exceptions.)
Returns an exception of class TestFailedException
with failedExceptionStackDepth
set to 0 and
all frames above this stack depth severed off. This can be useful when working with tools (such as IDEs) that do not
directly support ScalaTest. (Tools that directly support ScalaTest can use the stack depth information delivered
in the StackDepth exceptions.)
- Inherited from:
- TestFailedException
Inherited fields
A string that provides the absolute filename and line number of the line of code that failed, suitable
for presenting to a user of the failing line. It calls failedCodeFilePathname
and
failedCodeLineNumber
to get the failing absolute filename and line number.
A string that provides the absolute filename and line number of the line of code that failed, suitable
for presenting to a user of the failing line. It calls failedCodeFilePathname
and
failedCodeLineNumber
to get the failing absolute filename and line number.
- Returns:
a user-presentable string containing the absolute filename and line number that caused the failed test
- Inherited from:
- StackDepth
The depth in the stack trace of this exception at which the line of test code that failed resides.
The depth in the stack trace of this exception at which the line of test code that failed resides.
One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will
usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property
will often be StackDepthException
s, but whose failedCodeStackDepth
will never be used. Another reason is to remove the need
to create a different exception before creating this one just for the purpose of searching through its stack
trace for the proper stack depth. Still one more reason is to allow the message to contain information about the
stack depth, such as the failed file name and line number.
- Inherited from:
- StackDepthException
An optional detail message for this StackDepth
exception.
An optional detail message for this StackDepth
exception.
One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will
usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property
will often be StackDepthException
s, but whose message
will never be used. Another related reason is to remove the need
to create a different exception before creating this one just for the purpose of searching through its stack
trace for the proper stack depth. Still one more reason is to allow the message to contain information about the
stack depth, such as the failed file name and line number.
- Inherited from:
- StackDepthException