-
Notifications
You must be signed in to change notification settings - Fork 516
/
ResourcePlatform.scala
67 lines (63 loc) · 2.14 KB
/
ResourcePlatform.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
* Copyright 2020-2023 Typelevel
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cats.effect.kernel
import javax.security.auth.Destroyable
/**
* JVM-specific Resource methods
*/
private[effect] trait ResourcePlatform extends Serializable {
/**
* Creates a [[Resource]] by wrapping a Java
* [[https://docs.oracle.com/javase/8/docs/api/javax/security/auth/Destroyable.html Destroyable]].
*
* @example
* {{{
* import java.security.KeyStore.PasswordProtection
* import cats.effect.{IO, Resource}
*
* def passwordProtection(getPassword: IO[Array[Char]]): Resource[IO, PasswordProtection] =
* Resource.fromDestroyable(
* getPassword.map(new PasswordProtection(_))
* )
* }}}
*
* @example
* {{{
* import java.security.KeyStore.PasswordProtection
* import cats.effect.{Resource, Sync}
* import cats.syntax.all._
*
* def passwordProtection[F[_]](getPassword: F[Array[Char]])(implicit F: Sync[F]): Resource[F, PasswordProtection] =
* Resource.fromDestroyable(
* getPassword.map(new PasswordProtection(_))
* )
* }}}
*
* @param acquire
* The effect with the resource to acquire.
* @param F
* the effect type in which the resource was acquired and will be released
* @tparam F
* the type of the effect
* @tparam A
* the type of the destroyable resource
* @return
* a Resource that will automatically destroy after use
*/
def fromDestroyable[F[_], A <: Destroyable](acquire: F[A])(
implicit F: Sync[F]): Resource[F, A] =
Resource.make(acquire)(destroyable => F.delay(destroyable.destroy()))
}