Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added orElse combinator to IO #2940

Merged
merged 5 commits into from
Apr 6, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions core/shared/src/main/scala/cats/effect/IO.scala
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,15 @@ sealed abstract class IO[+A] private () extends IOPlatform[A] {
def handleError[B >: A](f: Throwable => B): IO[B] =
handleErrorWith[B](t => IO.pure(f(t)))

/**
* Runs the current IO, if it fails with an error(exception), the other IO will be executed.
* @param other
* IO to be executed (if the current IO fails)
* @return
*/
def orElse[B >: A](other: IO[B]): IO[B] =
SemigroupK[IO].combineK(this, other)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go the other way around: leave this like you had it, and implement SemigroupK in terms of it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the input. I would follow that approach.


/**
* Handle any error, potentially recovering from it, by mapping it to another `IO` value.
*
Expand Down
10 changes: 10 additions & 0 deletions tests/shared/src/test/scala/cats/effect/IOSpec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,16 @@ class IOSpec extends BaseSpec with Discipline with IOPlatformSpecification {
IO.raiseError[Unit](TestException).attempt must completeAs(Left(TestException))
}

"orElse must return other if previous IO Fails" in ticked { implicit ticker =>
case object TestException extends RuntimeException
(IO.raiseError[Int](TestException) orElse IO.pure(42)) must completeAs(42)
}

"Return current IO if successful" in ticked { implicit ticker =>
case object TestException extends RuntimeException
(IO.pure(42) orElse IO.raiseError[Int](TestException)) must completeAs(42)
}

"attempt is redeem with Left(_) for recover and Right(_) for map" in ticked {
implicit ticker =>
forAll { (io: IO[Int]) => io.attempt eqv io.redeem(Left(_), Right(_)) }
Expand Down