spice.util.WorkResult.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spice-core_3 Show documentation

Core functionality leveraged and shared by most other sub-projects of YouI.

There is a newer version: 0.7.2

package spice.util

import cats.effect.IO

sealed trait WorkResult[Result]

object WorkResult {
  /**
   * The final result. The work if finished.
   */
  case class FinalResult[Result](result: Result) extends WorkResult[Result]

  /**
   * The intermediate result. The work is partially completed, but more work needs to be done before it's fully complete.
   * The `complete` will be asynchronously executed to finish the partially completed work.
   */
  case class ProgressiveResult[Result](result: Result, complete: IO[Result]) extends WorkResult[Result]
}