Resource

Resource data constructor that wraps an effect allocating a resource, along with its finalizers.

Resource data constructor that encodes the flatMap operation.

Type for signaling the exit condition of an effectful computation, that may either succeed, fail with an error or get canceled.

The types of exit signals are:

• Succeeded: for successful completion
• Errored: for termination in failure
• Canceled: for abortion

The names of the product elements

The name of the type

Creates a resource from an allocating effect.

Creates a resource from an allocating effect, with a finalizer that is able to distinguish between exit cases.

Creates a resource from an allocating effect, with a finalizer that is able to distinguish between exit cases.

The action takes a Poll[F] to allow for interruptible acquires, which is most often useful when acquiring lock-like structure: it should be possible to interrupt a fiber waiting on a lock, but if it does get acquired, release need to be guaranteed.

Note that in this case the acquire action should know how to cleanup after itself in case it gets canceled, since Resource will only guarantee release when acquire succeeds and fails (and when the actions in use or flatMap fail, succeed, or get canceled)

TODO make sure this api, which is more general than makeFull, doesn't allow for interruptible releases

Allocates two resources concurrently, and combines their results in a tuple.

Lifts an applicative into a resource. The resource has a no-op release. Preserves interruptibility of fa.

Creates a Resource by wrapping a Java AutoCloseable.

In most real world cases, implementors of AutoCloseable are blocking as well, so the close action runs in the blocking context.

Example:

 import cats.effect._
 import scala.io.Source

 def reader[F[_]](data: String)(implicit F: Sync[F]): Resource[F, Source] =
   Resource.fromAutoCloseable(F.blocking {
     Source.fromString(data)
   })

Lifts an applicative into a resource as a FunctionK. The resource has a no-op release.

Creates a resource from an acquiring effect and a release function.

Creates a resource from an acquiring effect and a release function that can discriminate between different exit cases.

Creates a resource from an acquiring effect and a release function that can discriminate between different exit cases.

The acquiring effect takes a Poll[F] to allow for interruptible acquires, which is most often useful when acquiring lock-like structures: it should be possible to interrupt a fiber waiting on a lock, but if it does get acquired, release need to be guaranteed.

Note that in this case the acquire action should know how to cleanup after itself in case it gets canceled, since Resource will only guarantee release when acquire succeeds and fails (and when the actions in use or flatMap fail, succeed, or get canceled)

Creates a resource from an acquiring effect and a release function that can discriminate between different exit cases.

The acquiring effect takes a Poll[F] to allow for interruptible acquires, which is most often useful when acquiring lock-like structures: it should be possible to interrupt a fiber waiting on a lock, but if it does get acquired, release need to be guaranteed.

Note that in this case the acquire action should know how to cleanup after itself in case it gets canceled, since Resource will only guarantee release when acquire succeeds and fails (and when the actions in use or flatMap fail, succeed, or get canceled)

Lifts a finalizer into a resource. The resource has a no-op allocation.

Creates a resource that allocates immediately without any effects, but calls release when closing, providing the the usage completed with.

Lifts a pure value into a resource. The resource has a no-op release.

Races the evaluation of two resource allocations and returns the result of the winner, except in the case of cancelation.

Given a Resource suspended in F[_], lifts it in the Resource context.

A resource with a no-op allocation and a no-op release.

Creates a Resource by wrapping a Java Destroyable.

Example:

 import java.security.KeyStore.PasswordProtection
 import cats.effect._
 import cats.syntax.all._

 def passwordProtection[F[_]](getPassword: F[Array[Char]])(implicit F: Sync[F]): Resource[F, PasswordProtection] =
   Resource.fromDestroyable(
     getPassword.map(new PasswordProtection(_))
   )