-
Notifications
You must be signed in to change notification settings - Fork 509
/
Clock.scala
236 lines (186 loc) · 7.37 KB
/
Clock.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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*
* 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 cats.{Applicative, Defer, Monad}
import cats.data._
import cats.kernel.{Monoid, Semigroup}
import scala.concurrent.duration.FiniteDuration
/**
* A typeclass which encodes various notions of time. Analogous to some of the time functions
* exposed by `java.lang.System`.
*/
trait Clock[F[_]] extends ClockPlatform[F] with Serializable {
def applicative: Applicative[F]
/**
* Monotonic time subject to the law that (monotonic, monotonic).mapN(_ <= _)
*
* Analogous to `java.lang.System.nanoTime`.
*/
def monotonic: F[FiniteDuration]
/**
* A representation of the current system time
*
* Analogous to `java.lang.System.currentTimeMillis`.
*/
def realTime: F[FiniteDuration]
/**
* Returns an effect that completes with the result of the source together with the duration
* that it took to complete.
*
* @param fa
* The effect which we wish to time the execution of
*/
def timed[A](fa: F[A]): F[(FiniteDuration, A)] =
applicative.map3(monotonic, fa, monotonic)((startTime, a, endTime) =>
(endTime.minus(startTime), a))
}
object Clock {
def apply[F[_]](implicit F: Clock[F]): F.type = F
implicit def clockForOptionT[F[_]](
implicit F0: Monad[F],
C0: Clock[F]): Clock[OptionT[F, *]] =
new OptionTClock[F] {
def applicative = OptionT.catsDataMonadForOptionT(F)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
}
implicit def clockForEitherT[F[_], E](
implicit F0: Monad[F],
C0: Clock[F]): Clock[EitherT[F, E, *]] =
new EitherTClock[F, E] {
def applicative = EitherT.catsDataMonadErrorForEitherT(F)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
}
implicit def clockForStateT[F[_], S](
implicit F0: Monad[F],
C0: Clock[F]): Clock[StateT[F, S, *]] =
new StateTClock[F, S] {
def applicative = IndexedStateT.catsDataMonadForIndexedStateT(F)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
}
implicit def clockForWriterT[F[_], L](
implicit F0: Monad[F],
C0: Clock[F],
L0: Monoid[L]): Clock[WriterT[F, L, *]] =
new WriterTClock[F, L] {
def applicative = WriterT.catsDataMonadForWriterT(F, L)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
implicit override def L: Monoid[L] = L0
}
implicit def clockForIorT[F[_], L](
implicit F0: Monad[F],
C0: Clock[F],
L0: Semigroup[L]): Clock[IorT[F, L, *]] =
new IorTClock[F, L] {
def applicative = IorT.catsDataMonadErrorForIorT(F, L)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
implicit override def L: Semigroup[L] = L0
}
implicit def clockForKleisli[F[_], R](
implicit F0: Monad[F],
C0: Clock[F]): Clock[Kleisli[F, R, *]] =
new KleisliClock[F, R] {
def applicative = Kleisli.catsDataMonadForKleisli(F)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
}
implicit def clockForContT[F[_], R](
implicit F0: Monad[F],
C0: Clock[F],
D0: Defer[F]): Clock[ContT[F, R, *]] =
new ContTClock[F, R] {
def applicative = ContT.catsDataContTMonad(D)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
implicit override def D: Defer[F] = D0
}
implicit def clockForReaderWriterStateT[F[_], R, L, S](
implicit F0: Monad[F],
C0: Clock[F],
L0: Monoid[L]): Clock[ReaderWriterStateT[F, R, L, S, *]] =
new ReaderWriterStateTClock[F, R, L, S] {
def applicative = IndexedReaderWriterStateT.catsDataMonadForRWST(F, L)
implicit override def F: Monad[F] = F0
implicit override def C: Clock[F] = C0
implicit override def L: Monoid[L] = L0
}
private[kernel] trait OptionTClock[F[_]] extends Clock[OptionT[F, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
override def monotonic: OptionT[F, FiniteDuration] =
OptionT.liftF(C.monotonic)
override def realTime: OptionT[F, FiniteDuration] = OptionT.liftF(C.realTime)
}
private[kernel] trait EitherTClock[F[_], E] extends Clock[EitherT[F, E, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
override def monotonic: EitherT[F, E, FiniteDuration] =
EitherT.liftF(C.monotonic)
override def realTime: EitherT[F, E, FiniteDuration] = EitherT.liftF(C.realTime)
}
private[kernel] trait StateTClock[F[_], S] extends Clock[StateT[F, S, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
override def monotonic: IndexedStateT[F, S, S, FiniteDuration] =
StateT.liftF(C.monotonic)
override def realTime: IndexedStateT[F, S, S, FiniteDuration] =
StateT.liftF(C.realTime)
}
private[kernel] trait WriterTClock[F[_], L] extends Clock[WriterT[F, L, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
implicit protected def L: Monoid[L]
override def monotonic: WriterT[F, L, FiniteDuration] =
WriterT.liftF(C.monotonic)
override def realTime: WriterT[F, L, FiniteDuration] = WriterT.liftF(C.realTime)
}
private[kernel] trait IorTClock[F[_], L] extends Clock[IorT[F, L, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
implicit protected def L: Semigroup[L]
override def monotonic: IorT[F, L, FiniteDuration] = IorT.liftF(C.monotonic)
override def realTime: IorT[F, L, FiniteDuration] = IorT.liftF(C.realTime)
}
private[kernel] trait KleisliClock[F[_], R] extends Clock[Kleisli[F, R, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
override def monotonic: Kleisli[F, R, FiniteDuration] =
Kleisli.liftF(C.monotonic)
override def realTime: Kleisli[F, R, FiniteDuration] = Kleisli.liftF(C.realTime)
}
private[kernel] trait ContTClock[F[_], R] extends Clock[ContT[F, R, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
implicit protected def D: Defer[F]
override def monotonic: ContT[F, R, FiniteDuration] =
ContT.liftF(C.monotonic)
override def realTime: ContT[F, R, FiniteDuration] = ContT.liftF(C.realTime)
}
private[kernel] trait ReaderWriterStateTClock[F[_], R, L, S]
extends Clock[ReaderWriterStateT[F, R, L, S, *]] {
implicit protected def F: Monad[F]
implicit protected def C: Clock[F]
implicit protected def L: Monoid[L]
override def monotonic: ReaderWriterStateT[F, R, L, S, FiniteDuration] =
IndexedReaderWriterStateT.liftF(C.monotonic)
override def realTime: ReaderWriterStateT[F, R, L, S, FiniteDuration] =
IndexedReaderWriterStateT.liftF(C.realTime)
}
}