Class/Object

monix.eval.Task

Attempt

Related Docs: object Attempt | package Task

Permalink

sealed abstract class Attempt[+A] extends Task[A]

The Attempt represents a strict, already evaluated result of a Task that either resulted in success, wrapped in a Now, or in an error, wrapped in a Error.

It's the moral equivalent of scala.util.Try.

Self Type
Attempt[A]
Linear Supertypes
Task[A], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Attempt
  2. Task
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def asScala: Try[A]

    Permalink

    Converts this attempt into a scala.util.Try.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def coeval(implicit s: Scheduler): Coeval[Either[CancelableFuture[A], A]]

    Permalink

    Transforms a Task into a Coeval that tries to execute the source synchronously, returning either Right(value) in case a value is available immediately, or Left(future) in case we have an asynchronous boundary.

    Transforms a Task into a Coeval that tries to execute the source synchronously, returning either Right(value) in case a value is available immediately, or Left(future) in case we have an asynchronous boundary.

    Definition Classes
    Task
  8. def delayExecution(timespan: FiniteDuration): Task[A]

    Permalink

    Returns a task that waits for the specified timespan before executing and mirroring the result of the source.

    Returns a task that waits for the specified timespan before executing and mirroring the result of the source.

    Definition Classes
    Task
  9. def delayExecutionWith(trigger: Task[Any]): Task[A]

    Permalink

    Returns a task that waits for the specified trigger to succeed before mirroring the result of the source.

    Returns a task that waits for the specified trigger to succeed before mirroring the result of the source.

    If the trigger ends in error, then the resulting task will also end in error.

    Definition Classes
    Task
  10. def delayResult(timespan: FiniteDuration): Task[A]

    Permalink

    Returns a task that executes the source immediately on runAsync, but before emitting the onSuccess result for the specified duration.

    Returns a task that executes the source immediately on runAsync, but before emitting the onSuccess result for the specified duration.

    Note that if an error happens, then it is streamed immediately with no delay.

    Definition Classes
    Task
  11. def delayResultBySelector[B](selector: (A) ⇒ Task[B]): Task[A]

    Permalink

    Returns a task that executes the source immediately on runAsync, but before emitting the onSuccess result for the specified duration.

    Returns a task that executes the source immediately on runAsync, but before emitting the onSuccess result for the specified duration.

    Note that if an error happens, then it is streamed immediately with no delay.

    Definition Classes
    Task
  12. def dematerialize[B](implicit ev: <:<[A, Try[B]]): Task[B]

    Permalink

    Dematerializes the source's result from a Try.

    Dematerializes the source's result from a Try.

    Definition Classes
    Task
  13. def dematerializeAttempt[B](implicit ev: <:<[A, Attempt[B]]): Attempt[B]

    Permalink

    Dematerializes the source's result from an Attempt.

    Dematerializes the source's result from an Attempt.

    Definition Classes
    AttemptTask
  14. def doOnFinish(f: (Option[Throwable]) ⇒ Task[Unit]): Task[A]

    Permalink

    Returns a new Task in which f is scheduled to be run on completion.

    Returns a new Task in which f is scheduled to be run on completion. This would typically be used to release any resources acquired by this Task.

    The returned Task completes when both the source and the task returned by f complete.

    Definition Classes
    Task
  15. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def failed: Attempt[Throwable]

    Permalink

    Returns a failed projection of this task.

    Returns a failed projection of this task.

    The failed projection is a future holding a value of type Throwable, emitting a value which is the throwable of the original task in case the original task fails, otherwise if the source succeeds, then it fails with a NoSuchElementException.

    Definition Classes
    AttemptTask
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def flatMap[B](f: (A) ⇒ Task[B]): Task[B]

    Permalink

    Creates a new Task by applying a function to the successful result of the source Task, and returns a task equivalent to the result of the function.

    Creates a new Task by applying a function to the successful result of the source Task, and returns a task equivalent to the result of the function.

    Definition Classes
    Task
  20. def flatten[B](implicit ev: <:<[A, Task[B]]): Task[B]

    Permalink

    Given a source Task that emits another Task, this function flattens the result, returning a Task equivalent to the emitted Task by the source.

    Given a source Task that emits another Task, this function flattens the result, returning a Task equivalent to the emitted Task by the source.

    Definition Classes
    Task
  21. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  23. def isFailure: Boolean

    Permalink

    Returns true if result is an error.

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def isSuccess: Boolean

    Permalink

    Returns true if value is a successful one.

  26. def map[B](f: (A) ⇒ B): Task[B]

    Permalink

    Returns a new Task that applies the mapping function to the element emitted by the source.

    Returns a new Task that applies the mapping function to the element emitted by the source.

    Definition Classes
    Task
  27. def materialize: Task[Try[A]]

    Permalink

    Creates a new Task that will expose any triggered error from the source.

    Creates a new Task that will expose any triggered error from the source.

    Definition Classes
    Task
  28. def materializeAttempt: Attempt[Attempt[A]]

    Permalink

    Creates a new Task that will expose any triggered error from the source.

    Creates a new Task that will expose any triggered error from the source.

    Definition Classes
    AttemptTask
  29. def memoize: Task[A]

    Permalink

    Memoizes the result on the computation and reuses it on subsequent invocations of runAsync.

    Memoizes the result on the computation and reuses it on subsequent invocations of runAsync.

    Definition Classes
    Task
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def onErrorFallbackTo[B >: A](that: Task[B]): Task[B]

    Permalink

    Creates a new task that in case of error will fallback to the given backup task.

    Creates a new task that in case of error will fallback to the given backup task.

    Definition Classes
    Task
  34. def onErrorHandle[U >: A](f: (Throwable) ⇒ U): Task[U]

    Permalink

    Creates a new task that will handle any matching throwable that this task might emit.

    Creates a new task that will handle any matching throwable that this task might emit.

    See onErrorRecover for the version that takes a partial function.

    Definition Classes
    Task
  35. def onErrorHandleWith[B >: A](f: (Throwable) ⇒ Task[B]): Task[B]

    Permalink

    Creates a new task that will handle any matching throwable that this task might emit by executing another task.

    Creates a new task that will handle any matching throwable that this task might emit by executing another task.

    See onErrorRecoverWith for the version that takes a partial function.

    Definition Classes
    Task
  36. def onErrorRecover[U >: A](pf: PartialFunction[Throwable, U]): Task[U]

    Permalink

    Creates a new task that on error will try to map the error to another value using the provided partial function.

    Creates a new task that on error will try to map the error to another value using the provided partial function.

    See onErrorHandle for the version that takes a total function.

    Definition Classes
    Task
  37. def onErrorRecoverWith[B >: A](pf: PartialFunction[Throwable, Task[B]]): Task[B]

    Permalink

    Creates a new task that will try recovering from an error by matching it with another task using the given partial function.

    Creates a new task that will try recovering from an error by matching it with another task using the given partial function.

    See onErrorHandleWith for the version that takes a total function.

    Definition Classes
    Task
  38. def onErrorRestart(maxRetries: Long): Task[A]

    Permalink

    Creates a new task that in case of error will retry executing the source again and again, until it succeeds.

    Creates a new task that in case of error will retry executing the source again and again, until it succeeds.

    In case of continuous failure the total number of executions will be maxRetries + 1.

    Definition Classes
    Task
  39. def onErrorRestartIf(p: (Throwable) ⇒ Boolean): Task[A]

    Permalink

    Creates a new task that in case of error will retry executing the source again and again, until it succeeds.

    Creates a new task that in case of error will retry executing the source again and again, until it succeeds.

    In case of continuous failure the total number of executions will be maxRetries + 1.

    Definition Classes
    Task
  40. def restartUntil(p: (A) ⇒ Boolean): Task[A]

    Permalink

    Given a predicate function, keep retrying the task until the function returns true.

    Given a predicate function, keep retrying the task until the function returns true.

    Definition Classes
    Task
  41. def runAsync(implicit s: Scheduler): CancelableFuture[A]

    Permalink

    Triggers the asynchronous execution.

    Triggers the asynchronous execution.

    returns

    a CancelableFuture that can be used to extract the result or to cancel a running task.

    Definition Classes
    Task
  42. def runAsync(f: (Try[A]) ⇒ Unit)(implicit s: Scheduler): Cancelable

    Permalink

    Triggers the asynchronous execution.

    Triggers the asynchronous execution.

    f

    is a callback that will be invoked upon completion.

    returns

    a Cancelable that can be used to cancel a running task

    Definition Classes
    Task
  43. def runAsync(cb: Callback[A])(implicit s: Scheduler): Cancelable

    Permalink

    Triggers the asynchronous execution.

    Triggers the asynchronous execution.

    cb

    is a callback that will be invoked upon completion.

    returns

    a Cancelable that can be used to cancel a running task

    Definition Classes
    Task
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def timeout(after: FiniteDuration): Task[A]

    Permalink

    Returns a Task that mirrors the source Task but that triggers a TimeoutException in case the given duration passes without the task emitting any item.

    Returns a Task that mirrors the source Task but that triggers a TimeoutException in case the given duration passes without the task emitting any item.

    Definition Classes
    Task
  46. def timeoutTo[B >: A](after: FiniteDuration, backup: Task[B]): Task[B]

    Permalink

    Returns a Task that mirrors the source Task but switches to the given backup Task in case the given duration passes without the source emitting any item.

    Returns a Task that mirrors the source Task but switches to the given backup Task in case the given duration passes without the source emitting any item.

    Definition Classes
    Task
  47. def toReactivePublisher[B >: A](implicit s: Scheduler): Publisher[B]

    Permalink

    Converts a Task to an org.reactivestreams.Publisher that emits a single item on success, or just the error on failure.

    Converts a Task to an org.reactivestreams.Publisher that emits a single item on success, or just the error on failure.

    See reactive-streams.org for the Reactive Streams specification.

    Definition Classes
    Task
  48. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  49. def value: A

    Permalink

    Evaluates the underlying computation and returns the result.

    Evaluates the underlying computation and returns the result.

    NOTE: this can throw exceptions.

  50. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. def zip[B](that: Task[B]): Task[(A, B)]

    Permalink

    Zips the values of this and that task, and creates a new task that will emit the tuple of their results.

    Zips the values of this and that task, and creates a new task that will emit the tuple of their results.

    Definition Classes
    Task
  54. def zipWith[B, C](that: Task[B])(f: (A, B) ⇒ C): Task[C]

    Permalink

    Zips the values of this and that and applies the given mapping function on their results.

    Zips the values of this and that and applies the given mapping function on their results.

    Definition Classes
    Task

Inherited from Task[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped