-
Notifications
You must be signed in to change notification settings - Fork 451
/
Copy pathValidated.kt
1319 lines (1206 loc) · 41.3 KB
/
Validated.kt
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
package arrow.core
import arrow.typeclasses.Monoid
import arrow.typeclasses.Semigroup
import arrow.core.Either.Left
import arrow.core.Either.Right
import arrow.typeclasses.MonoidDeprecation
import arrow.typeclasses.combine
import kotlin.experimental.ExperimentalTypeInference
import kotlin.jvm.JvmName
import kotlin.jvm.JvmStatic
@Deprecated(
ValidatedDeprMsg + "ValidatedNel is being replaced by EitherNel",
ReplaceWith("EitherNel<E, A>", "arrow.core.EitherNel")
)
public typealias ValidatedNel<E, A> = Validated<Nel<E>, A>
@Deprecated(
ValidatedDeprMsg + "Use Right to construct Either values instead",
ReplaceWith("Either.Right(value)", "arrow.core.Either")
)
public typealias Valid<A> = Validated.Valid<A>
@Deprecated(
ValidatedDeprMsg + "Use Left to construct Either values instead",
ReplaceWith("Either.Left(value)", "arrow.core.Either")
)
public typealias Invalid<E> = Validated.Invalid<E>
@Deprecated(ValidatedDeprMsg + "You can find more details about how to migrate on the Github release page, or the 1.2.0 release post.")
public sealed class Validated<out E, out A> {
public companion object {
@Deprecated(
ValidatedDeprMsg + "Use leftNel instead to construct the equivalent Either value",
ReplaceWith("e.leftNel()", "arrow.core.leftNel")
)
@JvmStatic
public fun <E, A> invalidNel(e: E): ValidatedNel<E, A> = Invalid(nonEmptyListOf(e))
@Deprecated(
ValidatedDeprMsg + "Use right instead to construct the equivalent Either value",
ReplaceWith("a.right()", "arrow.core.right")
)
@JvmStatic
public fun <E, A> validNel(a: A): ValidatedNel<E, A> = Valid(a)
/**
* Converts an `Either<E, A>` to a `Validated<E, A>`.
*/
@Deprecated(ValidatedDeprMsg)
@JvmStatic
public fun <E, A> fromEither(e: Either<E, A>): Validated<E, A> = e.fold({ Invalid(it) }, { Valid(it) })
/**
* Converts an `Option<A>` to a `Validated<E, A>`, where the provided `ifNone` output value is returned as [Invalid]
* when the specified `Option` is `None`.
*/
@Deprecated(
DeprAndNicheMsg + "Prefer using toEither on Option instead",
ReplaceWith("o.toEither(ifNone).toValidated()")
)
@JvmStatic
public inline fun <E, A> fromOption(o: Option<A>, ifNone: () -> E): Validated<E, A> =
o.fold(
{ Invalid(ifNone()) },
{ Valid(it) }
)
/**
* Converts a nullable `A?` to a `Validated<E, A>`, where the provided `ifNull` output value is returned as [Invalid]
* when the specified value is null.
*/
@Deprecated(
DeprAndNicheMsg + "Prefer Kotlin nullable syntax, or ensureNotNull inside Either DSL",
ReplaceWith("value?.valid() ?: ifNull().invalid()")
)
@JvmStatic
public inline fun <E, A> fromNullable(value: A?, ifNull: () -> E): Validated<E, A> =
value?.let(::Valid) ?: Invalid(ifNull())
@Deprecated(
ValidatedDeprMsg + "Use Either.catch instead",
ReplaceWith("Either.catch(f).toValidated()")
)
@JvmStatic
@JvmName("tryCatch")
public inline fun <A> catch(f: () -> A): Validated<Throwable, A> =
try {
f().valid()
} catch (e: Throwable) {
e.nonFatalOrThrow().invalid()
}
@Deprecated(
DeprAndNicheMsg + "Use Either.catch and mapLeft instead",
ReplaceWith("Either.catch(f).mapLeft(recover).toValidated()")
)
@JvmStatic
@JvmName("tryCatch")
public inline fun <E, A> catch(recover: (Throwable) -> E, f: () -> A): Validated<E, A> =
catch(f).mapLeft(recover)
@Deprecated(
DeprAndNicheMsg + "Use Either.catch and toEitherNel instead",
ReplaceWith("Either.catch(f).toEitherNel().toValidated()")
)
@JvmStatic
public inline fun <A> catchNel(f: () -> A): ValidatedNel<Throwable, A> =
try {
f().validNel()
} catch (e: Throwable) {
e.nonFatalOrThrow().invalidNel()
}
@Deprecated(
DeprAndNicheMsg + "Prefer creating explicit lambdas instead",
ReplaceWith("{ it.map(f) }")
)
@JvmStatic
public inline fun <E, A, B> lift(crossinline f: (A) -> B): (Validated<E, A>) -> Validated<E, B> =
{ fa -> fa.map(f) }
/**
* Lifts two functions to the Bifunctor type.
*
* ```kotlin
* import arrow.core.*
*
* fun main(args: Array<String>) {
* //sampleStart
* val f = Validated.lift(String::toUpperCase, Int::inc)
* val res1 = f("test".invalid())
* val res2 = f(1.valid())
* //sampleEnd
* println("res1: $res1")
* println("res2: $res2")
* }
* ```
* <!--- KNIT example-validated-01.kt -->
*/
@Deprecated(
DeprAndNicheMsg + "Prefer creating explicit lambdas instead",
ReplaceWith("{ it.bimap(fl, fr) }")
)
@JvmStatic
public inline fun <A, B, C, D> lift(
crossinline fl: (A) -> C,
crossinline fr: (B) -> D
): (Validated<A, B>) -> Validated<C, D> =
{ fa -> fa.bimap(fl, fr) }
}
/**
* Discards the [A] value inside [Validated] signaling this container may be pointing to a noop
* or an effect whose return value is deliberately ignored. The singleton value [Unit] serves as signal.
*
* ```kotlin
* import arrow.core.*
*
* fun main(args: Array<String>) {
* val result =
* //sampleStart
* "Hello World".valid().void()
* //sampleEnd
* println(result)
* }
* ```
* <!--- KNIT example-validated-02.kt -->
*/
@Deprecated(
DeprAndNicheMsg + "Use map on Either after refactoring instead",
ReplaceWith("toEither().map { }.toValidated()")
)
public fun void(): Validated<E, Unit> =
map { Unit }
@Deprecated(
DeprAndNicheMsg + "Prefer using the Either DSL, or explicit fold or when",
ReplaceWith(
"fold({ emptyList() }, { fa(it).map(::Valid) })",
"arrow.core.Valid"
)
)
@OptIn(ExperimentalTypeInference::class)
@OverloadResolutionByLambdaReturnType
public inline fun <B> traverse(fa: (A) -> Iterable<B>): List<Validated<E, B>> =
fold({ emptyList() }, { a -> fa(a).map { Valid(it) } })
@Deprecated(
DeprAndNicheMsg + "Prefer using the Either DSL, or explicit fold or when",
ReplaceWith(
"fold({ it.invalid().right() }, { fa(it).map(::Valid) })",
"arrow.core.invalid", "arrow.core.right", "arrow.core.Valid"
)
)
@OptIn(ExperimentalTypeInference::class)
@OverloadResolutionByLambdaReturnType
public inline fun <EE, B> traverse(fa: (A) -> Either<EE, B>): Either<EE, Validated<E, B>> =
when (this) {
is Valid -> fa(this.value).map { Valid(it) }
is Invalid -> this.right()
}
@Deprecated("traverseEither is being renamed to traverse to simplify the Arrow API", ReplaceWith("traverse(fa)"))
public inline fun <EE, B> traverseEither(fa: (A) -> Either<EE, B>): Either<EE, Validated<E, B>> =
traverse(fa)
@Deprecated(
DeprAndNicheMsg + "Prefer using the Either DSL, or explicit fold or when",
ReplaceWith(
"fold({ None }, { fa(it).map(::Valid) })",
"arrow.core.None", "arrow.core.Valid"
)
)
@OptIn(ExperimentalTypeInference::class)
@OverloadResolutionByLambdaReturnType
public inline fun <B> traverse(fa: (A) -> Option<B>): Option<Validated<E, B>> =
when (this) {
is Valid -> fa(this.value).map { Valid(it) }
is Invalid -> None
}
@Deprecated("traverseOption is being renamed to traverse to simplify the Arrow API", ReplaceWith("traverse(fa)"))
public inline fun <B> traverseOption(fa: (A) -> Option<B>): Option<Validated<E, B>> =
traverse(fa)
@Deprecated(
DeprAndNicheMsg + "Use orNull() and Kotlin nullable types",
ReplaceWith("orNull()?.let(fa)?.valid()", "arrow.core.valid")
)
public inline fun <B> traverseNullable(fa: (A) -> B?): Validated<E, B>? =
when (this) {
is Valid -> fa(this.value)?.let { Valid(it) }
is Invalid -> null
}
@Deprecated(
DeprAndNicheMsg + "Prefer when or fold instead",
ReplaceWith("fold({ fe(c, it) }, { fa(c, it) })")
)
public inline fun <B> bifoldLeft(
c: B,
fe: (B, E) -> B,
fa: (B, A) -> B
): B =
fold({ fe(c, it) }, { fa(c, it) })
@Deprecated(
DeprAndNicheMsg + "Prefer when or fold instead",
ReplaceWith("fold(g, f)")
)
public inline fun <B> bifoldMap(MN: Monoid<B>, g: (E) -> B, f: (A) -> B): B =
fold(g, f)
@Deprecated(
DeprAndNicheMsg + "Prefer explicit fold instead",
ReplaceWith(
"fold({ fe(it).map { Invalid(it) } }, { fa(it).map { Valid(it) } })",
"arrow.core.Valid", "arrow.core.Invalid"
)
)
public inline fun <EE, B> bitraverse(fe: (E) -> Iterable<EE>, fa: (A) -> Iterable<B>): List<Validated<EE, B>> =
fold({ fe(it).map { Invalid(it) } }, { fa(it).map { Valid(it) } })
@Deprecated(
DeprAndNicheMsg + "Prefer explicit fold instead",
ReplaceWith(
"fold({ fe(it).map { Invalid(it) } }, { fa(it).map { Valid(it) } })",
"arrow.core.Valid", "arrow.core.Invalid"
)
)
public inline fun <EE, B, C> bitraverseEither(
fe: (E) -> Either<EE, B>,
fa: (A) -> Either<EE, C>
): Either<EE, Validated<B, C>> =
fold({ fe(it).map { Invalid(it) } }, { fa(it).map { Valid(it) } })
@Deprecated(
DeprAndNicheMsg + "Prefer explicit fold instead",
ReplaceWith(
"fold({ fe(it).map(::Invalid) }, { fa(it).map(::Valid) })",
"arrow.core.Valid", "arrow.core.Invalid"
)
)
public inline fun <B, C> bitraverseOption(
fe: (E) -> Option<B>,
fa: (A) -> Option<C>
): Option<Validated<B, C>> =
fold({ fe(it).map(::Invalid) }, { fa(it).map(::Valid) })
@Deprecated(
DeprAndNicheMsg + "Prefer explicit fold instead",
ReplaceWith(
"fold({ fe(it)?.let(::Invalid) }, { fa(it)?.let(::Valid) })",
"arrow.core.Valid", "arrow.core.Invalid"
)
)
public inline fun <B, C> bitraverseNullable(
fe: (E) -> B?,
fa: (A) -> C?
): Validated<B, C>? =
fold({ fe(it)?.let(::Invalid) }, { fa(it)?.let(::Valid) })
@Deprecated(
ValidatedDeprMsg + "Use fold on Either after refactoring instead",
ReplaceWith("toEither().fold({ MB.empty() }, f)")
)
public inline fun <B> foldMap(MB: Monoid<B>, f: (A) -> B): B =
fold({ MB.empty() }, f)
override fun toString(): String = fold(
{ "Validated.Invalid($it)" },
{ "Validated.Valid($it)" }
)
@Deprecated(
ValidatedDeprMsg + "Use Right to construct Either values instead",
ReplaceWith("Either.Right(value)", "arrow.core.Either")
)
public data class Valid<out A>(val value: A) : Validated<Nothing, A>() {
override fun toString(): String = "Validated.Valid($value)"
public companion object {
@PublishedApi
internal val unit: Validated<Nothing, Unit> =
Validated.Valid(Unit)
}
}
@Deprecated(
ValidatedDeprMsg + "Use Left to construct Either values instead",
ReplaceWith("Either.Left(value)", "arrow.core.Either")
)
public data class Invalid<out E>(val value: E) : Validated<E, Nothing>() {
override fun toString(): String = "Validated.Invalid($value)"
}
@Deprecated(
ValidatedDeprMsg + "Use fold on Either after refactoring",
ReplaceWith("toEither().fold(fe, fa)")
)
public inline fun <B> fold(fe: (E) -> B, fa: (A) -> B): B =
when (this) {
is Valid -> fa(value)
is Invalid -> (fe(value))
}
@Deprecated(
ValidatedDeprMsg + "Use isRight on Either after refactoring",
ReplaceWith("toEither().isRight()")
)
public val isValid: Boolean =
fold({ false }, { true })
@Deprecated(
ValidatedDeprMsg + "Use isLeft on Either after refactoring",
ReplaceWith("toEither().isLeft()")
)
public val isInvalid: Boolean =
fold({ true }, { false })
/**
* Is this Valid and matching the given predicate
*/
@Deprecated(
ValidatedDeprMsg + "Use isRight on Either after refactoring",
ReplaceWith("toEither().isRight(predicate)")
)
public inline fun exist(predicate: (A) -> Boolean): Boolean =
fold({ false }, predicate)
@Deprecated(
DeprAndNicheMsg + "Use getOrNull and takeIf on Either after refactoring",
ReplaceWith("toEither().getOrNull()?.takeIf(predicate)")
)
public inline fun findOrNull(predicate: (A) -> Boolean): A? =
when (this) {
is Valid -> if (predicate(this.value)) this.value else null
is Invalid -> null
}
@Deprecated(
DeprAndNicheMsg + "Use fold on Either after refactoring",
ReplaceWith("toEither().fold({ true }, predicate)")
)
public inline fun all(predicate: (A) -> Boolean): Boolean =
fold({ true }, predicate)
@Deprecated(
ValidatedDeprMsg + "Use isRight on Either after refactoring",
ReplaceWith("toEither().isLeft()")
)
public fun isEmpty(): Boolean = isInvalid
@Deprecated(
ValidatedDeprMsg + "Use isRight on Either after refactoring",
ReplaceWith("toEither().isRight()")
)
public fun isNotEmpty(): Boolean = isValid
/**
* Converts the value to an Either<E, A>
*/
public fun toEither(): Either<E, A> =
fold(::Left, ::Right)
/**
* Returns Valid values wrapped in Some, and None for Invalid values
*/
@Deprecated(
ValidatedDeprMsg + "Use getOrNone on Either after refactoring",
ReplaceWith("toEither().getOrNone()")
)
public fun toOption(): Option<A> =
fold({ None }, ::Some)
/**
* Convert this value to a single element List if it is Valid,
* otherwise return an empty List
*/
@Deprecated(
DeprAndNicheMsg + "Use fold instead",
ReplaceWith("fold({ emptyList() }, ::listOf)")
)
public fun toList(): List<A> =
fold({ listOf() }, ::listOf)
/** Lift the Invalid value into a NonEmptyList. */
@Deprecated(
ValidatedDeprMsg + "Use toEitherNel directly instead",
ReplaceWith("toEither().toEitherNel().toValidated()")
)
public fun toValidatedNel(): ValidatedNel<E, A> =
fold({ invalidNel(it) }, ::Valid)
/**
* Convert to an Either, apply a function, convert back. This is handy
* when you want to use the Monadic properties of the Either type.
*/
@Deprecated(
ValidatedDeprMsg + "Use Either directly instead",
ReplaceWith("toEither().let(f).toValidated()")
)
public inline fun <EE, B> withEither(f: (Either<E, A>) -> Either<EE, B>): Validated<EE, B> =
fromEither(f(toEither()))
/**
* From [arrow.typeclasses.Bifunctor], maps both types of this Validated.
*
* Apply a function to an Invalid or Valid value, returning a new Invalid or Valid value respectively.
*/
public inline fun <EE, B> bimap(fe: (E) -> EE, fa: (A) -> B): Validated<EE, B> =
fold({ Invalid(fe(it)) }, { Valid(fa(it)) })
/**
* Apply a function to a Valid value, returning a new Valid value
*/
@Deprecated(
ValidatedDeprMsg + "Use map on Either after refactoring",
ReplaceWith("toEither().map(f).toValidated()")
)
public inline fun <B> map(f: (A) -> B): Validated<E, B> =
bimap(::identity, f)
/**
* Apply a function to an Invalid value, returning a new Invalid value.
* Or, if the original valid was Valid, return it.
*/
@Deprecated(
ValidatedDeprMsg + "Use mapLeft on Either after refactoring",
ReplaceWith("toEither().mapLeft(f).toValidated()")
)
public inline fun <EE> mapLeft(f: (E) -> EE): Validated<EE, A> =
bimap(f, ::identity)
/**
* The given function is applied as a fire and forget effect
* if this is `Invalid`.
* When applied the result is ignored and the original
* Validated value is returned
*
* Example:
* ```kotlin
* import arrow.core.Validated
*
* fun main() {
* Validated.Valid(12).tapInvalid { println("flower") } // Result: Valid(12)
* Validated.Invalid(12).tapInvalid { println("flower") } // Result: prints "flower" and returns: Invalid(12)
* }
* ```
* <!--- KNIT example-validated-03.kt -->
*/
@Deprecated(
ValidatedDeprMsg + "Use onLeft on Either after refactoring",
ReplaceWith("toEither().onLeft(f).toValidated()")
)
public inline fun tapInvalid(f: (E) -> Unit): Validated<E, A> =
when (this) {
is Invalid -> {
f(this.value)
this
}
is Valid -> this
}
/**
* The given function is applied as a fire and forget effect
* if this is `Valid`.
* When applied the result is ignored and the original
* Validated value is returned
*
* Example:
* ```kotlin
* import arrow.core.Validated
*
* fun main() {
* Validated.Valid(12).tap { println("flower") } // Result: prints "flower" and returns: Valid(12)
* Validated.Invalid(12).tap { println("flower") } // Result: Invalid(12)
* }
* ```
* <!--- KNIT example-validated-04.kt -->
*/
@Deprecated(
ValidatedDeprMsg + "Use onRight on Either after refactoring",
ReplaceWith("toEither().onRight(f).toValidated()")
)
public inline fun tap(f: (A) -> Unit): Validated<E, A> =
when (this) {
is Invalid -> this
is Valid -> {
f(this.value)
this
}
}
/**
* apply the given function to the value with the given B when
* valid, otherwise return the given B
*/
@Deprecated(
ValidatedDeprMsg + "Use fold on Either after refactoring",
ReplaceWith("toEither().fold({ b }) { f(b, it) }")
)
public inline fun <B> foldLeft(b: B, f: (B, A) -> B): B =
fold({ b }, { f(b, it) })
@Deprecated(
ValidatedDeprMsg + "Use swap on Either after refactoring",
ReplaceWith("toEither().swap()")
)
public fun swap(): Validated<A, E> =
fold(::Valid, ::Invalid)
}
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), fb.toEither(), ::Pair).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public fun <E, A, B> Validated<E, A>.zip(SE: Semigroup<E>, fb: Validated<E, B>): Validated<E, Pair<A, B>> =
Either.zipOrAccumulate(SE::combine, toEither(), fb.toEither(), ::Pair).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
f: (A, B) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), f).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
f: (A, B, C) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), f).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
f: (A, B, C, D) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), f).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
f: (A, B, C, D, EE) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), f)
.toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, FF, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
ff: Validated<E, FF>,
f: (A, B, C, D, EE, FF) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(
SE::combine,
toEither(),
b.toEither(),
c.toEither(),
d.toEither(),
e.toEither(),
ff.toEither(),
f
).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, F, G, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
ff: Validated<E, F>,
g: Validated<E, G>,
f: (A, B, C, D, EE, F, G) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(
SE::combine,
toEither(),
b.toEither(),
c.toEither(),
d.toEither(),
e.toEither(),
ff.toEither(),
g.toEither(),
f
).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
ff: Validated<E, F>,
g: Validated<E, G>,
h: Validated<E, H>,
f: (A, B, C, D, EE, F, G, H) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(
SE::combine,
toEither(),
b.toEither(),
c.toEither(),
d.toEither(),
e.toEither(),
ff.toEither(),
g.toEither(),
h.toEither(),
f
).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), i.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, I, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
ff: Validated<E, F>,
g: Validated<E, G>,
h: Validated<E, H>,
i: Validated<E, I>,
f: (A, B, C, D, EE, F, G, H, I) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(
SE::combine,
toEither(),
b.toEither(),
c.toEither(),
d.toEither(),
e.toEither(),
ff.toEither(),
g.toEither(),
h.toEither(),
i.toEither(),
f
).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(SE::combine, toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), i.toEither(), j.toEither(), f).toValidated()",
"arrow.core.Either",
"arrow.typeclasses.combine"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, I, J, Z> Validated<E, A>.zip(
SE: Semigroup<E>,
b: Validated<E, B>,
c: Validated<E, C>,
d: Validated<E, D>,
e: Validated<E, EE>,
ff: Validated<E, F>,
g: Validated<E, G>,
h: Validated<E, H>,
i: Validated<E, I>,
j: Validated<E, J>,
f: (A, B, C, D, EE, F, G, H, I, J) -> Z
): Validated<E, Z> =
Either.zipOrAccumulate(
SE::combine,
toEither(),
b.toEither(),
c.toEither(),
d.toEither(),
e.toEither(),
ff.toEither(),
g.toEither(),
h.toEither(),
i.toEither(),
j.toEither(),
f
).toValidated()
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
f: (A, B) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
f: (A, B, C) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
f: (A, B, C, D) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
f: (A, B, C, D, EE) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, FF, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
ff: ValidatedNel<E, FF>,
f: (A, B, C, D, EE, FF) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, ff, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, F, G, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
ff: ValidatedNel<E, F>,
g: ValidatedNel<E, G>,
f: (A, B, C, D, EE, F, G) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, ff, g, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
ff: ValidatedNel<E, F>,
g: ValidatedNel<E, G>,
h: ValidatedNel<E, H>,
f: (A, B, C, D, EE, F, G, H) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, ff, g, h, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), i.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, I, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
ff: ValidatedNel<E, F>,
g: ValidatedNel<E, G>,
h: ValidatedNel<E, H>,
i: ValidatedNel<E, I>,
f: (A, B, C, D, EE, F, G, H, I) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, ff, g, h, i, f)
@Deprecated(
ValidatedDeprMsg + "zipOrAccumulate for Either now exposes this same functionality",
ReplaceWith(
"Either.zipOrAccumulate(toEither(), b.toEither(), c.toEither(), d.toEither(), e.toEither(), ff.toEither(), g.toEither(), h.toEither(), i.toEither(), j.toEither(), f).toValidated()",
"arrow.core.Either"
)
)
public inline fun <E, A, B, C, D, EE, F, G, H, I, J, Z> ValidatedNel<E, A>.zip(
b: ValidatedNel<E, B>,
c: ValidatedNel<E, C>,
d: ValidatedNel<E, D>,
e: ValidatedNel<E, EE>,
ff: ValidatedNel<E, F>,
g: ValidatedNel<E, G>,
h: ValidatedNel<E, H>,
i: ValidatedNel<E, I>,
j: ValidatedNel<E, J>,
f: (A, B, C, D, EE, F, G, H, I, J) -> Z
): ValidatedNel<E, Z> =
zip(Semigroup.nonEmptyList(), b, c, d, e, ff, g, h, i, j, f)
/**
* Given [A] is a sub type of [B], re-type this value from Validated<E, A> to Validated<E, B>
*
* ```kotlin
* import arrow.core.*
*
* fun main(args: Array<String>) {
* //sampleStart
* val string: Validated<Int, String> = "Hello".valid()
* val chars: Validated<Int, CharSequence> =
* string.widen<Int, CharSequence, String>()
* //sampleEnd
* println(chars)
* }
* ```
* <!--- KNIT example-validated-05.kt -->
*/
@Deprecated(
ValidatedDeprMsg + "Use widen on Either after refactoring",
ReplaceWith("toEither().widen()")
)
public fun <E, B, A : B> Validated<E, A>.widen(): Validated<E, B> =
this
@Deprecated(
ValidatedDeprMsg + "Use leftWiden on Either after refactoring",
ReplaceWith("toEither().leftWiden()")
)
public fun <EE, E : EE, A> Validated<E, A>.leftWiden(): Validated<EE, A> =
this
@Deprecated(
DeprAndNicheMsg + "Prefer using the Either DSL, or map",
ReplaceWith(
"(0 until (n.coerceAtLeast(0))).mapOrAccumulate(SE::combine) { bind() }.toValidated()",
"arrow.typeclasses.combine"
)
)
public fun <E, A> Validated<E, A>.replicate(SE: Semigroup<E>, n: Int): Validated<E, List<A>> =
if (n <= 0) emptyList<A>().valid()
else this.zip(SE, replicate(SE, n - 1)) { a, xs -> listOf(a) + xs }
@Deprecated(DeprAndNicheMsg)
public fun <E, A> Validated<E, A>.replicate(SE: Semigroup<E>, n: Int, MA: Monoid<A>): Validated<E, A> =
if (n <= 0) MA.empty().valid()
else this@replicate.zip(SE, replicate(SE, n - 1, MA)) { a, xs -> MA.run { a + xs } }
@Deprecated(
DeprAndNicheMsg + "Prefer explicit fold instead",
ReplaceWith(
"fold({ it.map { Invalid(it) } }, { it.map { Valid(it) } })",