-
Notifications
You must be signed in to change notification settings - Fork 506
/
IO.scala
1421 lines (1335 loc) · 50.6 KB
/
IO.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2017-2018 The Typelevel Cats-effect Project Developers
*
* 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
package effect
import cats.arrow.FunctionK
import cats.effect.internals._
import cats.effect.internals.TrampolineEC.immediate
import cats.effect.internals.IOPlatform.fusionMaxStackDepth
import scala.annotation.unchecked.uncheckedVariance
import scala.concurrent.duration._
import scala.concurrent.{ExecutionContext, Future, Promise, TimeoutException}
import scala.util.control.NonFatal
import scala.util.{Failure, Left, Right, Success}
/**
* A pure abstraction representing the intention to perform a
* side effect, where the result of that side effect may be obtained
* synchronously (via return) or asynchronously (via callback).
*
* `IO` values are pure, immutable values and thus preserve
* referential transparency, being usable in functional programming.
* An `IO` is a data structure that represents just a description
* of a side effectful computation.
*
* `IO` can describe synchronous or asynchronous computations that:
*
* 1. on evaluation yield exactly one result
* 1. can end in either success or failure and in case of failure
* `flatMap` chains get short-circuited (`IO` implementing
* the algebra of `MonadError`)
* 1. can be canceled, but note this capability relies on the
* user to provide cancellation logic
*
* Effects described via this abstraction are not evaluated until
* the "end of the world", which is to say, when one of the "unsafe"
* methods are used. Effectful results are not memoized, meaning that
* memory overhead is minimal (and no leaks), and also that a single
* effect may be run multiple times in a referentially-transparent
* manner. For example:
*
* {{{
* val ioa = IO { println("hey!") }
*
* val program = for {
* _ <- ioa
* _ <- ioa
* } yield ()
*
* program.unsafeRunSync()
* }}}
*
* The above will print "hey!" twice, as the effect will be re-run
* each time it is sequenced in the monadic chain.
*
* `IO` is trampolined in its `flatMap` evaluation. This means that
* you can safely call `flatMap` in a recursive function of arbitrary
* depth, without fear of blowing the stack.
*
* {{{
* def fib(n: Int, a: Long = 0, b: Long = 1): IO[Long] =
* IO(a + b).flatMap { b2 =>
* if (n > 0)
* fib(n - 1, b, b2)
* else
* IO.pure(b2)
* }
* }}}
*/
sealed abstract class IO[+A] extends internals.IOBinaryCompat[A] {
import IO._
/**
* Functor map on `IO`. Given a mapping functions, it transforms the
* value produced by the source, while keeping the `IO` context.
*
* Any exceptions thrown within the function will be caught and
* sequenced into the `IO`, because due to the nature of
* asynchronous processes, without catching and handling exceptions,
* failures would be completely silent and `IO` references would
* never terminate on evaluation.
*/
final def map[B](f: A => B): IO[B] =
this match {
case Map(source, g, index) =>
// Allowed to do fixed number of map operations fused before
// resetting the counter in order to avoid stack overflows;
// See `IOPlatform` for details on this maximum.
if (index != fusionMaxStackDepth) Map(source, g.andThen(f), index + 1)
else Map(this, f, 0)
case _ =>
Map(this, f, 0)
}
/**
* Monadic bind on `IO`, used for sequentially composing two `IO`
* actions, where the value produced by the first `IO` is passed as
* input to a function producing the second `IO` action.
*
* Due to this operation's signature, `flatMap` forces a data
* dependency between two `IO` actions, thus ensuring sequencing
* (e.g. one action to be executed before another one).
*
* Any exceptions thrown within the function will be caught and
* sequenced into the `IO`, because due to the nature of
* asynchronous processes, without catching and handling exceptions,
* failures would be completely silent and `IO` references would
* never terminate on evaluation.
*/
final def flatMap[B](f: A => IO[B]): IO[B] =
Bind(this, f)
/**
* Materializes any sequenced exceptions into value space, where
* they may be handled.
*
* This is analogous to the `catch` clause in `try`/`catch`, being
* the inverse of `IO.raiseError`. Thus:
*
* {{{
* IO.raiseError(ex).attempt.unsafeRunAsync === Left(ex)
* }}}
*
* @see [[IO.raiseError]]
*/
def attempt: IO[Either[Throwable, A]] =
Bind(this, AttemptIO.asInstanceOf[A => IO[Either[Throwable, A]]])
/**
* Produces an `IO` reference that should execute the source on
* evaluation, without waiting for its result, being the safe
* analogue to [[unsafeRunAsync]].
*
* This operation is isomorphic to [[unsafeRunAsync]]. What it does
* is to let you describe asynchronous execution with a function
* that stores off the results of the original `IO` as a
* side effect, thus ''avoiding'' the usage of impure callbacks or
* eager evaluation.
*
* The returned `IO` is guaranteed to execute immediately,
* and does not wait on any async action to complete, thus this
* is safe to do, even on top of runtimes that cannot block threads
* (e.g. JavaScript):
*
* {{{
* // Sample
* val source = IO.shift *> IO(1)
* // Describes execution
* val start = source.runAsync {
* case Left(e) => IO(e.printStackTrace())
* case Right(_) => IO.unit
* }
* // Safe, because it does not block for the source to finish
* start.unsafeRunSync
* }}}
*
* @return an `IO` value that upon evaluation will execute the source,
* but will not wait for its completion
*
* @see [[runCancelable]] for the version that gives you a cancelable
* token that can be used to send a cancel signal
*/
final def runAsync(cb: Either[Throwable, A] => IO[Unit]): IO[Unit] = IO {
unsafeRunAsync(cb.andThen(_.unsafeRunAsync(Callback.report)))
}
final def runSyncStep: IO[Either[IO[A], A]] = IO.suspend {
IORunLoop.step(this) match {
case Pure(a) => Pure(Right(a))
case r @ RaiseError(_) => r
case async => Pure(Left(async))
}
}
/**
* Produces an `IO` reference that should execute the source on evaluation,
* without waiting for its result and return a cancelable token, being the
* safe analogue to [[unsafeRunCancelable]].
*
* This operation is isomorphic to [[unsafeRunCancelable]]. Just like
* [[runAsync]], this operation avoids the usage of impure callbacks or
* eager evaluation.
*
* The returned `IO` boxes an `IO[Unit]` that can be used to cancel the
* running asynchronous computation (if the source can be canceled).
*
* The returned `IO` is guaranteed to execute immediately,
* and does not wait on any async action to complete, thus this
* is safe to do, even on top of runtimes that cannot block threads
* (e.g. JavaScript):
*
* {{{
* val source: IO[Int] = ???
* // Describes interruptible execution
* val start: IO[IO[Unit]] = source.runCancelable
*
* // Safe, because it does not block for the source to finish
* val cancel: IO[Unit] = start.unsafeRunSync
*
* // Safe, because cancellation only sends a signal,
* // but doesn't back-pressure on anything
* cancel.unsafeRunSync
* }}}
*
* @return an `IO` value that upon evaluation will execute the source,
* but will not wait for its completion, yielding a cancellation
* token that can be used to cancel the async process
*
* @see [[runAsync]] for the simple, uninterruptible version
*/
final def runCancelable(cb: Either[Throwable, A] => IO[Unit]): IO[IO[Unit]] = IO {
val cancel = unsafeRunCancelable(cb.andThen(_.unsafeRunAsync(_ => ())))
IO.Delay(cancel)
}
/**
* Produces the result by running the encapsulated effects as impure
* side effects.
*
* If any component of the computation is asynchronous, the current
* thread will block awaiting the results of the async computation.
* On JavaScript, an exception will be thrown instead to avoid
* generating a deadlock. By default, this blocking will be
* unbounded. To limit the thread block to some fixed time, use
* `unsafeRunTimed` instead.
*
* Any exceptions raised within the effect will be re-thrown during
* evaluation.
*
* As the name says, this is an UNSAFE function as it is impure and
* performs side effects, not to mention blocking, throwing
* exceptions, and doing other things that are at odds with
* reasonable software. You should ideally only call this function
* *once*, at the very end of your program.
*/
final def unsafeRunSync(): A = unsafeRunTimed(Duration.Inf).get
/**
* Passes the result of the encapsulated effects to the given
* callback by running them as impure side effects.
*
* Any exceptions raised within the effect will be passed to the
* callback in the `Either`. The callback will be invoked at most
* *once*. Note that it is very possible to construct an IO which
* never returns while still never blocking a thread, and attempting
* to evaluate that IO with this method will result in a situation
* where the callback is *never* invoked.
*
* As the name says, this is an UNSAFE function as it is impure and
* performs side effects. You should ideally only call this
* function ''once'', at the very end of your program.
*/
final def unsafeRunAsync(cb: Either[Throwable, A] => Unit): Unit =
IORunLoop.start(this, cb)
/**
* Evaluates the source `IO`, passing the result of the encapsulated
* effects to the given callback.
*
* As the name says, this is an UNSAFE function as it is impure and
* performs side effects. You should ideally only call this
* function ''once'', at the very end of your program.
*
* @return an side-effectful function that, when executed, sends a
* cancellation reference to `IO`'s run-loop implementation,
* having the potential to interrupt it.
*/
final def unsafeRunCancelable(cb: Either[Throwable, A] => Unit): () => Unit = {
val conn = IOConnection()
IORunLoop.startCancelable(this, conn, cb)
conn.cancel
}
/**
* Similar to `unsafeRunSync`, except with a bounded blocking
* duration when awaiting asynchronous results.
*
* Please note that the `limit` parameter does not limit the time of
* the total computation, but rather acts as an upper bound on any
* *individual* asynchronous block. Thus, if you pass a limit of `5
* seconds` to an `IO` consisting solely of synchronous actions, the
* evaluation may take considerably longer than 5 seconds!
* Furthermore, if you pass a limit of `5 seconds` to an `IO`
* consisting of several asynchronous actions joined together,
* evaluation may take up to `n * 5 seconds`, where `n` is the
* number of joined async actions.
*
* As soon as an async blocking limit is hit, evaluation
* ''immediately'' aborts and `None` is returned.
*
* Please note that this function is intended for ''testing''; it
* should never appear in your mainline production code! It is
* absolutely not an appropriate function to use if you want to
* implement timeouts, or anything similar. If you need that sort
* of functionality, you should be using a streaming library (like
* fs2 or Monix).
*
* @see [[unsafeRunSync]]
* @see [[timeout]] for pure and safe version
*/
final def unsafeRunTimed(limit: Duration): Option[A] =
IORunLoop.step(this) match {
case Pure(a) => Some(a)
case RaiseError(e) => throw e
case self @ Async(_, _) =>
IOPlatform.unsafeResync(self, limit)
case _ =>
// $COVERAGE-OFF$
throw new AssertionError("unreachable")
// $COVERAGE-ON$
}
/**
* Evaluates the effect and produces the result in a `Future`.
*
* This is similar to `unsafeRunAsync` in that it evaluates the `IO`
* as a side effect in a non-blocking fashion, but uses a `Future`
* rather than an explicit callback. This function should really
* only be used if interoperating with legacy code which uses Scala
* futures.
*
* @see [[IO.fromFuture]]
*/
final def unsafeToFuture(): Future[A] = {
val p = Promise[A]
unsafeRunAsync(_.fold(p.failure, p.success))
p.future
}
/**
* Start execution of the source suspended in the `IO` context.
*
* This can be used for non-deterministic / concurrent execution.
* The following code is more or less equivalent with `parMap2`
* (minus the behavior on error handling and cancellation):
*
* {{{
* def par2[A, B](ioa: IO[A], iob: IO[B]): IO[(A, B)] =
* for {
* fa <- ioa.start
* fb <- iob.start
* a <- fa.join
* b <- fb.join
* } yield (a, b)
* }}}
*
* Note in such a case usage of `parMapN` (via `cats.Parallel`) is
* still recommended because of behavior on error and cancellation —
* consider in the example above what would happen if the first task
* finishes in error. In that case the second task doesn't get canceled,
* which creates a potential memory leak.
*/
final def start(implicit timer: Timer[IO]): IO[Fiber[IO, A @uncheckedVariance]] =
IOStart(timer, this)
/**
* Returns a new `IO` that mirrors the source task for normal termination,
* but that triggers the given error on cancellation.
*
* Normally tasks that are canceled become non-terminating.
*
* This `onCancelRaiseError` operator transforms a task that is
* non-terminating on cancellation into one that yields an error,
* thus equivalent with [[IO.raiseError]].
*/
final def onCancelRaiseError(e: Throwable): IO[A] =
IOCancel.raise(this, e)
/**
* Makes the source `IO` uninterruptible such that a [[Fiber.cancel]]
* signal has no effect.
*/
final def uncancelable: IO[A] =
IOCancel.uncancelable(this)
/**
* Converts the source `IO` into any `F` type that implements
* the [[LiftIO]] type class.
*/
final def to[F[_]](implicit F: LiftIO[F]): F[A @uncheckedVariance] =
F.liftIO(this)
/**
* Returns an IO that either completes with the result of the source within
* the specified time `duration` or otherwise evaluates the `fallback`.
*
* The source is cancelled in the event that it takes longer than
* the `FiniteDuration` to complete, the evaluation of the fallback
* happening immediately after that.
*
* @param duration is the time span for which we wait for the source to
* complete; in the event that the specified time has passed without
* the source completing, the `fallback` gets evaluated
*
* @param fallback is the task evaluated after the duration has passed and
* the source canceled
*/
final def timeoutTo[A2 >: A](duration: FiniteDuration, fallback: IO[A2])(implicit timer: Timer[IO]): IO[A2] =
Concurrent.timeoutTo(this, duration, fallback)
/**
* Returns an IO that either completes with the result of the source within
* the specified time `duration` or otherwise raises a `TimeoutException`.
*
* The source is cancelled in the event that it takes longer than
* the specified time duration to complete.
*
* @param duration is the time span for which we wait for the source to
* complete; in the event that the specified time has passed without
* the source completing, a `TimeoutException` is raised
*/
final def timeout(duration: FiniteDuration)(implicit timer: Timer[IO]): IO[A] =
timeoutTo(duration, IO.raiseError(new TimeoutException(duration.toString)))
/**
* Returns an `IO` action that treats the source task as the
* acquisition of a resource, which is then exploited by the `use`
* function and then `released`.
*
* The `bracket` operation is the equivalent of the
* `try {} catch {} finally {}` statements from mainstream languages.
*
* The `bracket` operation installs the necessary exception handler
* to release the resource in the event of an exception being raised
* during the computation, or in case of cancellation.
*
* If an exception is raised, then `bracket` will re-raise the
* exception ''after'' performing the `release`. If the resulting
* task gets canceled, then `bracket` will still perform the
* `release`, but the yielded task will be non-terminating
* (equivalent with [[IO.never]]).
*
* Example:
*
* {{{
* import java.io._
*
* def readFile(file: File): IO[String] = {
* // Opening a file handle for reading text
* val acquire = IO(new BufferedReader(
* new InputStreamReader(new FileInputStream(file), "utf-8")
* ))
*
* acquire.bracket { in =>
* // Usage part
* IO {
* // Yes, ugly Java, non-FP loop;
* // side-effects are suspended though
* var line: String = null
* val buff = new StringBuilder()
* do {
* line = in.readLine()
* if (line != null) buff.append(line)
* } while (line != null)
* buff.toString()
* }
* } { in =>
* // The release part
* IO(in.close())
* }
* }
* }}}
*
* Note that in case of cancellation the underlying implementation
* cannot guarantee that the computation described by `use` doesn't
* end up executed concurrently with the computation from
* `release`. In the example above that ugly Java loop might end up
* reading from a `BufferedReader` that is already closed due to the
* task being canceled, thus triggering an error in the background
* with nowhere to get signaled.
*
* In this particular example, given that we are just reading from a
* file, it doesn't matter. But in other cases it might matter, as
* concurrency on top of the JVM when dealing with I/O might lead to
* corrupted data.
*
* For those cases you might want to do synchronization (e.g. usage
* of locks and semaphores) and you might want to use [[bracketCase]],
* the version that allows you to differentiate between normal
* termination and cancellation.
*
* '''NOTE on error handling''': one big difference versus
* `try/finally` statements is that, in case both the `release`
* function and the `use` function throws, the error raised by `use`
* gets signaled.
*
* For example:
*
* {{{
* IO("resource").bracket { _ =>
* // use
* IO.raiseError(new RuntimeException("Foo"))
* } { _ =>
* // release
* IO.raiseError(new RuntimeException("Bar"))
* }
* }}}
*
* In this case the error signaled downstream is `"Foo"`, while the
* `"Bar"` error gets reported. This is consistent with the behavior
* of Haskell's `bracket` operation and NOT with `try {} finally {}`
* from Scala, Java or JavaScript.
*
* @see [[bracketCase]]
*
* @param use is a function that evaluates the resource yielded by
* the source, yielding a result that will get generated by
* the task returned by this `bracket` function
*
* @param release is a function that gets called after `use`
* terminates, either normally or in error, or if it gets
* canceled, receiving as input the resource that needs to
* be released
*/
final def bracket[B](use: A => IO[B])(release: A => IO[Unit]): IO[B] =
bracketCase(use)((a, _) => release(a))
/**
* Returns a new `IO` task that treats the source task as the
* acquisition of a resource, which is then exploited by the `use`
* function and then `released`, with the possibility of
* distinguishing between normal termination and cancellation, such
* that an appropriate release of resources can be executed.
*
* The `bracketCase` operation is the equivalent of
* `try {} catch {} finally {}` statements from mainstream languages
* when used for the acquisition and release of resources.
*
* The `bracketCase` operation installs the necessary exception handler
* to release the resource in the event of an exception being raised
* during the computation, or in case of cancellation.
*
* In comparison with the simpler [[bracket]] version, this one
* allows the caller to differentiate between normal termination,
* termination in error and cancellation via an [[ExitCase]]
* parameter.
*
* @see [[bracket]]
*
* @param use is a function that evaluates the resource yielded by
* the source, yielding a result that will get generated by
* this function on evaluation
*
* @param release is a function that gets called after `use`
* terminates, either normally or in error, or if it gets
* canceled, receiving as input the resource that needs that
* needs release, along with the result of `use`
* (cancellation, error or successful result)
*/
def bracketCase[B](use: A => IO[B])(release: (A, ExitCase[Throwable]) => IO[Unit]): IO[B] =
IOBracket(this)(use)(release)
/**
* Executes the given `finalizer` when the source is finished,
* either in success or in error, or if canceled.
*
* This variant of [[guaranteeCase]] evaluates the given `finalizer`
* regardless of how the source gets terminated:
*
* - normal completion
* - completion in error
* - cancelation
*
* This equivalence always holds:
*
* {{{
* io.guarantee(f) <-> IO.unit.bracket(_ => io)(_ => f)
* }}}
*
* As best practice, it's not a good idea to release resources
* via `guaranteeCase` in polymorphic code. Prefer [[bracket]]
* for the acquisition and release of resources.
*
* @see [[guaranteeCase]] for the version that can discriminate
* between termination conditions
*
* @see [[bracket]] for the more general operation
*/
def guarantee(finalizer: IO[Unit]): IO[A] =
guaranteeCase(_ => finalizer)
/**
* Executes the given `finalizer` when the source is finished,
* either in success or in error, or if canceled, allowing
* for differentiating between exit conditions.
*
* This variant of [[guarantee]] injects an [[ExitCase]] in
* the provided function, allowing one to make a difference
* between:
*
* - normal completion
* - completion in error
* - cancelation
*
* This equivalence always holds:
*
* {{{
* io.guaranteeCase(f) <-> IO.unit.bracketCase(_ => io)((_, e) => f(e))
* }}}
*
* As best practice, it's not a good idea to release resources
* via `guaranteeCase` in polymorphic code. Prefer [[bracketCase]]
* for the acquisition and release of resources.
*
* @see [[guarantee]] for the simpler version
*
* @see [[bracketCase]] for the more general operation
*/
def guaranteeCase(finalizer: ExitCase[Throwable] => IO[Unit]): IO[A] =
IOBracket.guaranteeCase(this, finalizer)
/**
* Handle any error, potentially recovering from it, by mapping it to another
* `IO` value.
*
* Implements `ApplicativeError.handleErrorWith`.
*/
def handleErrorWith[AA >: A](f: Throwable => IO[AA]): IO[AA] =
IO.Bind(this, new IOFrame.ErrorHandler(f))
/**
* Returns a new value that transforms the result of the source,
* given the `recover` or `map` functions, which get executed depending
* on whether the result is successful or if it ends in error.
*
* This is an optimization on usage of [[attempt]] and [[map]],
* this equivalence being true:
*
* {{{
* io.redeem(recover, map) <-> io.attempt.map(_.fold(recover, map))
* }}}
*
* Usage of `redeem` subsumes `handleError` because:
*
* {{{
* io.redeem(fe, id) <-> io.handleError(fe)
* }}}
*
* @param recover is a function used for error recover in case the
* source ends in error
* @param map is a function used for mapping the result of the source
* in case it ends in success
*/
def redeem[B](recover: Throwable => B, map: A => B): IO[B] =
IO.Bind(this, new IOFrame.Redeem(recover, map))
/**
* Returns a new value that transforms the result of the source,
* given the `recover` or `bind` functions, which get executed depending
* on whether the result is successful or if it ends in error.
*
* This is an optimization on usage of [[attempt]] and [[flatMap]],
* this equivalence being available:
*
* {{{
* io.redeemWith(recover, bind) <-> io.attempt.flatMap(_.fold(recover, bind))
* }}}
*
* Usage of `redeemWith` subsumes `handleErrorWith` because:
*
* {{{
* io.redeemWith(fe, F.pure) <-> io.handleErrorWith(fe)
* }}}
*
* Usage of `redeemWith` also subsumes [[flatMap]] because:
*
* {{{
* io.redeemWith(F.raiseError, fs) <-> io.flatMap(fs)
* }}}
*
* @param recover is the function that gets called to recover the source
* in case of error
* @param bind is the function that gets to transform the source
* in case of success
*/
def redeemWith[B](recover: Throwable => IO[B], bind: A => IO[B]): IO[B] =
IO.Bind(this, new IOFrame.RedeemWith(recover, bind))
override def toString: String = this match {
case Pure(a) => s"IO($a)"
case RaiseError(e) => s"IO(throw $e)"
case _ => "IO$" + System.identityHashCode(this)
}
}
private[effect] abstract class IOParallelNewtype
extends internals.IOTimerRef with internals.IOCompanionBinaryCompat {
/**
* Newtype encoding for an `IO` datatype that has a `cats.Applicative`
* capable of doing parallel processing in `ap` and `map2`, needed
* for implementing `cats.Parallel`.
*
* Helpers are provided for converting back and forth in `Par.apply`
* for wrapping any `IO` value and `Par.unwrap` for unwrapping.
*
* The encoding is based on the "newtypes" project by
* Alexander Konovalov, chosen because it's devoid of boxing issues and
* a good choice until opaque types will land in Scala.
*/
type Par[+A] = Par.Type[A]
/**
* Newtype encoding, see the [[IO.Par]] type alias
* for more details.
*/
object Par extends IONewtype
}
private[effect] abstract class IOLowPriorityInstances extends IOParallelNewtype {
private[effect] class IOSemigroup[A: Semigroup] extends Semigroup[IO[A]] {
def combine(ioa1: IO[A], ioa2: IO[A]) =
ioa1.flatMap(a1 => ioa2.map(a2 => Semigroup[A].combine(a1, a2)))
}
implicit def ioSemigroup[A: Semigroup]: Semigroup[IO[A]] = new IOSemigroup[A]
implicit val ioEffect: Effect[IO] = new IOEffect
private[effect] class IOEffect extends Effect[IO] with StackSafeMonad[IO] {
final override def pure[A](a: A): IO[A] =
IO.pure(a)
final override def unit: IO[Unit] =
IO.unit
final override def map[A, B](fa: IO[A])(f: A => B): IO[B] =
fa.map(f)
final override def flatMap[A, B](ioa: IO[A])(f: A => IO[B]): IO[B] =
ioa.flatMap(f)
final override def attempt[A](ioa: IO[A]): IO[Either[Throwable, A]] =
ioa.attempt
final override def handleErrorWith[A](ioa: IO[A])(f: Throwable => IO[A]): IO[A] =
ioa.handleErrorWith(f)
final override def raiseError[A](e: Throwable): IO[A] =
IO.raiseError(e)
final override def bracket[A, B](acquire: IO[A])
(use: A => IO[B])
(release: A => IO[Unit]): IO[B] =
acquire.bracket(use)(release)
final override def uncancelable[A](task: IO[A]): IO[A] =
task.uncancelable
final override def bracketCase[A, B](acquire: IO[A])
(use: A => IO[B])
(release: (A, ExitCase[Throwable]) => IO[Unit]): IO[B] =
acquire.bracketCase(use)(release)
final override def guarantee[A](fa: IO[A])(finalizer: IO[Unit]): IO[A] =
fa.guarantee(finalizer)
final override def guaranteeCase[A](fa: IO[A])(finalizer: ExitCase[Throwable] => IO[Unit]): IO[A] =
fa.guaranteeCase(finalizer)
final override def delay[A](thunk: => A): IO[A] =
IO(thunk)
final override def suspend[A](thunk: => IO[A]): IO[A] =
IO.suspend(thunk)
final override def async[A](k: (Either[Throwable, A] => Unit) => Unit): IO[A] =
IO.async(k)
final override def asyncF[A](k: (Either[Throwable, A] => Unit) => IO[Unit]): IO[A] =
IO.asyncF(k)
override def liftIO[A](ioa: IO[A]): IO[A] =
ioa
override def toIO[A](fa: IO[A]): IO[A] =
fa
final override def runAsync[A](ioa: IO[A])(cb: Either[Throwable, A] => IO[Unit]): IO[Unit] =
ioa.runAsync(cb)
final override def runSyncStep[A](ioa: IO[A]): IO[Either[IO[A], A]] =
ioa.runSyncStep
}
}
private[effect] abstract class IOInstances extends IOLowPriorityInstances {
implicit def parApplicative(implicit timer: Timer[IO]): Applicative[IO.Par] = new Applicative[IO.Par] {
import IO.Par.{unwrap, apply => par}
final override def pure[A](x: A): IO.Par[A] =
par(IO.pure(x))
final override def map2[A, B, Z](fa: IO.Par[A], fb: IO.Par[B])(f: (A, B) => Z): IO.Par[Z] =
par(IOParMap(timer, unwrap(fa), unwrap(fb))(f))
final override def ap[A, B](ff: IO.Par[A => B])(fa: IO.Par[A]): IO.Par[B] =
map2(ff, fa)(_(_))
final override def product[A, B](fa: IO.Par[A], fb: IO.Par[B]): IO.Par[(A, B)] =
map2(fa, fb)((_, _))
final override def map[A, B](fa: IO.Par[A])(f: A => B): IO.Par[B] =
par(unwrap(fa).map(f))
final override def unit: IO.Par[Unit] =
par(IO.unit)
}
implicit def ioConcurrentEffect(implicit timer: Timer[IO]): ConcurrentEffect[IO] = new IOEffect with ConcurrentEffect[IO] {
final override def start[A](fa: IO[A]): IO[Fiber[IO, A]] =
fa.start
final override def race[A, B](fa: IO[A], fb: IO[B]): IO[Either[A, B]] =
IO.race(fa, fb)
final override def racePair[A, B](fa: IO[A], fb: IO[B]): IO[Either[(A, Fiber[IO, B]), (Fiber[IO, A], B)]] =
IO.racePair(fa, fb)
final override def cancelable[A](k: (Either[Throwable, A] => Unit) => IO[Unit]): IO[A] =
IO.cancelable(k)
final override def runCancelable[A](fa: IO[A])(cb: Either[Throwable, A] => IO[Unit]): IO[IO[Unit]] =
fa.runCancelable(cb)
final override def toIO[A](fa: IO[A]): IO[A] = fa
final override def liftIO[A](ioa: IO[A]): IO[A] = ioa
}
implicit def ioParallel(implicit timer: Timer[IO]): Parallel[IO, IO.Par] =
new Parallel[IO, IO.Par] {
final override val applicative: Applicative[IO.Par] =
parApplicative(timer)
final override val monad: Monad[IO] =
ioConcurrentEffect(timer)
final override val sequential: ~>[IO.Par, IO] =
new FunctionK[IO.Par, IO] { def apply[A](fa: IO.Par[A]): IO[A] = IO.Par.unwrap(fa) }
final override val parallel: ~>[IO, IO.Par] =
new FunctionK[IO, IO.Par] { def apply[A](fa: IO[A]): IO.Par[A] = IO.Par(fa) }
}
implicit def ioMonoid[A: Monoid]: Monoid[IO[A]] = new IOSemigroup[A] with Monoid[IO[A]] {
final override def empty: IO[A] = IO.pure(Monoid[A].empty)
}
implicit val ioSemigroupK: SemigroupK[IO] = new SemigroupK[IO] {
final override def combineK[A](a: IO[A], b: IO[A]): IO[A] =
ApplicativeError[IO, Throwable].handleErrorWith(a)(_ => b)
}
}
/**
* @define shiftDesc For example we can introduce an asynchronous
* boundary in the `flatMap` chain before a certain task:
* {{{
* IO.shift.flatMap(_ => task)
* }}}
*
* Or using Cats syntax:
* {{{
* import cats.syntax.all._
*
* IO.shift *> task
* }}}
*
* Or we can specify an asynchronous boundary ''after'' the
* evaluation of a certain task:
* {{{
* task.flatMap(a => IO.shift.map(_ => a))
* }}}
*
* Or using Cats syntax:
* {{{
* task <* IO.shift
* }}}
*
* Example of where this might be useful:
* {{{
* for {
* _ <- IO.shift(BlockingIO)
* bytes <- readFileUsingJavaIO(file)
* _ <- IO.shift(DefaultPool)
*
* secure = encrypt(bytes, KeyManager)
* _ <- sendResponse(Protocol.v1, secure)
*
* _ <- IO { println("it worked!") }
* } yield ()
* }}}
*
* In the above, `readFileUsingJavaIO` will be shifted to the
* pool represented by `BlockingIO`, so long as it is defined
* using `apply` or `suspend` (which, judging by the name, it
* probably is). Once its computation is complete, the rest
* of the `for`-comprehension is shifted ''again'', this time
* onto the `DefaultPool`. This pool is used to compute the
* encrypted version of the bytes, which are then passed to
* `sendResponse`. If we assume that `sendResponse` is
* defined using `async` (perhaps backed by an NIO socket
* channel), then we don't actually know on which pool the
* final `IO` action (the `println`) will be run. If we
* wanted to ensure that the `println` runs on `DefaultPool`,
* we would insert another `shift` following `sendResponse`.
*
* Another somewhat less common application of `shift` is to
* reset the thread stack and yield control back to the
* underlying pool. For example:
*
* {{{
* lazy val repeat: IO[Unit] = for {
* _ <- doStuff
* _ <- IO.shift
* _ <- repeat
* } yield ()
* }}}
*
* In this example, `repeat` is a very long running `IO`
* (infinite, in fact!) which will just hog the underlying
* thread resource for as long as it continues running. This
* can be a bit of a problem, and so we inject the `IO.shift`
* which yields control back to the underlying thread pool,
* giving it a chance to reschedule things and provide better
* fairness. This shifting also "bounces" the thread stack,
* popping all the way back to the thread pool and effectively
* trampolining the remainder of the computation. This sort
* of manual trampolining is unnecessary if `doStuff` is
* defined using `suspend` or `apply`, but if it was defined
* using `async` and does ''not'' involve any real
* concurrency, the call to `shift` will be necessary to avoid
* a `StackOverflowError`.
*
* Thus, this function has four important use cases:
*
* - shifting blocking actions off of the main compute pool,
* - defensively re-shifting asynchronous continuations back
* to the main compute pool
* - yielding control to some underlying pool for fairness
* reasons, and
* - preventing an overflow of the call stack in the case of
* improperly constructed `async` actions
*
* Note there are 2 overloads of this function:
*
* - one that takes an [[Timer]] ([[IO.shift(implicit* link]])
* - one that takes a Scala `ExecutionContext` ([[IO.shift(ec* link]])
*
* Use the former by default, use the later for fine grained
* control over the thread pool used.
*/
object IO extends IOInstances {
/**
* Suspends a synchronous side effect in `IO`.
*
* Any exceptions thrown by the effect will be caught and sequenced
* into the `IO`.
*/
def apply[A](body: => A): IO[A] = Delay(body _)
/**
* Suspends a synchronous side effect which produces an `IO` in `IO`.
*
* This is useful for trampolining (i.e. when the side effect is
* conceptually the allocation of a stack frame). Any exceptions
* thrown by the side effect will be caught and sequenced into the
* `IO`.
*/
def suspend[A](thunk: => IO[A]): IO[A] =
Suspend(thunk _)
/**
* Suspends a pure value in `IO`.
*
* This should ''only'' be used if the value in question has
* "already" been computed! In other words, something like
* `IO.pure(readLine)` is most definitely not the right thing to do!
* However, `IO.pure(42)` is correct and will be more efficient
* (when evaluated) than `IO(42)`, due to avoiding the allocation of
* extra thunks.
*/
def pure[A](a: A): IO[A] = Pure(a)
/** Alias for `IO.pure(())`. */
val unit: IO[Unit] = pure(())
/**
* A non-terminating `IO`, alias for `async(_ => ())`.
*/
val never: IO[Nothing] = async(_ => ())
/**
* Lifts an `Eval` into `IO`.
*
* This function will preserve the evaluation semantics of any
* actions that are lifted into the pure `IO`. Eager `Eval`
* instances will be converted into thunk-less `IO` (i.e. eager
* `IO`), while lazy eval and memoized will be executed as such.
*/
def eval[A](fa: Eval[A]): IO[A] = fa match {
case Now(a) => pure(a)
case notNow => apply(notNow.value)
}