org.scalatest.concurrent.Futures
Indicates whether this future has been canceled.
Indicates whether this future has been canceled.
If the underlying future does not support the concept of cancellation, this method must always return false
.
Indicates whether this future has expired (timed out).
Indicates whether this future has expired (timed out).
The timeout detected by this method is different from the timeout supported by whenReady
. This timeout
is a timeout of the underlying future. If the underlying future does not support timeouts, this method must always
return false
.
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
This trait's implementation of this method queries the future repeatedly until it either is ready, or a configured maximum amount of time has passed, sleeping a configured interval between attempts; and when ready, returns the future's value. For greater efficiency, implementations of this trait may override this method so that it blocks the specified timeout while waiting for the result, if the underlying future supports this.
The maximum amount of time to wait for the future to become ready before giving up and throwing
TestFailedException
is configured by the timeout
field of
the PatienceConfig
passed implicitly as the last parameter.
The interval to sleep between queries of the future (used only if the future is polled) is configured by the interval
field of
the PatienceConfig
passed implicitly as the last parameter.
an PatienceConfig
object containing timeout
and
interval
parameters that are unused by this method
the result of the future once it is ready, if value
is defined as a Right
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
The maximum amount of time to wait for the future to become ready before giving up and throwing
TestFailedException
is configured by the timeout
field of
the PatienceConfig
passed implicitly as the last parameter.
The interval to sleep between queries of the future (used only if the future is polled) is configured by the value contained in the passed
interval
parameter.
This method invokes the overloaded futureValue
form with only one (implicit) argument
list that contains only one argument, a PatienceConfig
, passing a new
PatienceConfig
with the Interval
specified as interval
and
the Timeout
specified as config.timeout
.
the Interval
configuration parameter
an PatienceConfig
object containing timeout
and
interval
parameters that are unused by this method
the result of the future once it is ready, if value
is defined as a Right
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
The maximum amount of time to wait for the future to become ready before giving up and throwing
TestFailedException
is configured by the value contained in the passed
timeout
parameter.
The interval to sleep between queries of the future (used only if the future is polled) is configured by the interval
field of
the PatienceConfig
passed implicitly as the last parameter.
This method invokes the overloaded futureValue
form with only one (implicit) argument
list that contains only one argument, a PatienceConfig
, passing a new
PatienceConfig
with the Timeout
specified as timeout
and
the Interval
specified as config.interval
.
the Timeout
configuration parameter
an PatienceConfig
object containing timeout
and
interval
parameters that are unused by this method
the result of the future once it is ready, if value
is defined as a Right
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
Returns the result of this FutureConcept
, once it is ready, or throws either the
exception returned by the future (i.e., value
returned a Left
)
or TestFailedException
.
The maximum amount of time to wait for the future to become ready before giving up and throwing
TestFailedException
is configured by the value contained in the passed
timeout
parameter.
The interval to sleep between queries of the future (used only if the future is polled) is configured by the value contained in the passed
interval
parameter.
This method invokes the overloaded futureValue
form with only one (implicit) argument
list that contains only one argument, a PatienceConfig
, passing a new
PatienceConfig
with the Timeout
specified as timeout
and
the Interval
specified as interval
.
the Timeout
configuration parameter
the Interval
configuration parameter
the result of the future once it is ready, if value
is defined as a Right
Indicates whether this future is ready within the specified timeout.
Indicates whether this future is ready within the specified timeout.
If this future
@return
Concept trait for futures, instances of which are passed to the
whenReady
methods of traitFutures
.See the documentation for trait
Futures
for the details on the syntax this trait provides for testing with futures.