-
Notifications
You must be signed in to change notification settings - Fork 787
/
BackendBuilder.scala
53 lines (47 loc) · 1.94 KB
/
BackendBuilder.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
/*
* Copyright 2013 http4s.org
*
* 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 org.http4s.internal
import cats.effect.MonadCancelThrow
import cats.effect.Resource
import fs2.Stream
private[http4s] trait BackendBuilder[F[_], A] {
implicit protected def F: MonadCancelThrow[F]
/** Returns the backend as a resource. Resource acquire waits
* until the backend is ready to process requests.
*/
def resource: Resource[F, A]
/** Returns the backend as a single-element stream. The stream
* does not emit until the backend is ready to process requests.
* The backend is shut down when the stream is finalized.
*/
def stream: Stream[F, A] = Stream.resource(resource)
/** Returns an effect that allocates a backend and an `F[Unit]` to
* release it. The returned `F` waits until the backend is ready
* to process requests. The second element of the tuple shuts
* down the backend when run.
*
* Unlike [[resource]] and [[stream]], there is no automatic
* release of the backend. This function is intended for REPL
* sessions, tests, and other situations where composing a
* [[cats.effect.Resource]] or [[fs2.Stream]] is not tenable.
* [[resource]] or [[stream]] is recommended wherever possible.
*/
@deprecated(
"Use manually called '.resource.allocated' instead. Will be removed from public API in 1.0.",
"0.23.14",
)
def allocated: F[(A, F[Unit])] = resource.allocated
}