-
Notifications
You must be signed in to change notification settings - Fork 472
Add AccumulateContext utilities for error accumulation in Arrow Core Context #3948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nomisRev
wants to merge
2
commits into
main
Choose a base branch
from
nomisrev/missing-accumulate-context-functions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+85
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
...-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/context/AccumulateContext.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| @file:OptIn(ExperimentalTypeInference::class, ExperimentalContracts::class) | ||
| @file:JvmMultifileClass | ||
| @file:JvmName("RaiseContextualKt") | ||
| @file:Suppress("LEAKED_IN_PLACE_LAMBDA") | ||
|
|
||
| package arrow.core.raise.context | ||
|
|
||
| import arrow.core.Either | ||
| import arrow.core.EitherNel | ||
| import arrow.core.raise.ExperimentalRaiseAccumulateApi | ||
| import arrow.core.raise.RaiseAccumulate.Value | ||
| import arrow.core.raise.RaiseDSL | ||
| import arrow.core.raise.accumulating | ||
| import arrow.core.raise.ensureNotNullOrAccumulate | ||
| import arrow.core.raise.ensureOrAccumulate | ||
| import kotlin.contracts.ExperimentalContracts | ||
| import kotlin.contracts.InvocationKind.AT_MOST_ONCE | ||
| import kotlin.contracts.contract | ||
| import kotlin.experimental.ExperimentalTypeInference | ||
| import kotlin.jvm.JvmMultifileClass | ||
| import kotlin.jvm.JvmName | ||
|
|
||
| public typealias Accumulate<A> = arrow.core.raise.Accumulate<A> | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @JvmName("accumulateContextBindOr") | ||
| context(raise: Accumulate<Error>) | ||
| public fun <Error, A> Either<Error, A>.bindOrAccumulate(): Value<A> = | ||
| with(raise) { this@bindOrAccumulate.bindOrAccumulate() } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @JvmName("accumulateContextBindAll") | ||
| context(raise: Accumulate<Error>) | ||
| public fun <Error, A> Iterable<Either<Error, A>>.bindAllOrAccumulate(): Value<List<A>> = | ||
| with(raise) { this@bindAllOrAccumulate.bindAllOrAccumulate() } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @JvmName("accumulateContextBindNel") | ||
| context(raise: Accumulate<Error>) | ||
| public fun <Error, A> EitherNel<Error, A>.bindNelOrAccumulate(): Value<A> = | ||
| with(raise) { this@bindNelOrAccumulate.bindNelOrAccumulate() } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @RaiseDSL | ||
| @IgnorableReturnValue | ||
| @JvmName("accumulateContextEnsure") | ||
| context(raise: Accumulate<Error>) | ||
| public inline fun <Error> ensureOrAccumulate(condition: Boolean, error: () -> Error): Value<Unit> { | ||
| contract { callsInPlace(error, AT_MOST_ONCE) } | ||
| return raise.ensureOrAccumulate(condition, error) | ||
| } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @RaiseDSL | ||
| @JvmName("accumulateContextEnsureNotNull") | ||
| context(raise: Accumulate<Error>) | ||
| public inline fun <Error, B : Any> ensureNotNullOrAccumulate(value: B?, error: () -> Error): Value<B> { | ||
| contract { callsInPlace(error, AT_MOST_ONCE) } | ||
| return raise.ensureNotNullOrAccumulate(value, error) | ||
| } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @JvmName("accumulateContextGet") | ||
| context(raise: Accumulate<Error>) | ||
| public fun <Error, A> Either<Error, A>.getOrAccumulate(recover: (Error) -> A): A = | ||
| with(raise) { this@getOrAccumulate.getOrAccumulate(recover) } | ||
|
|
||
| @ExperimentalRaiseAccumulateApi | ||
| @JvmName("accumulateContextAccumulating") | ||
| context(raise: Accumulate<Error>) | ||
| public inline fun <Error, A> accumulating(block: context(RaiseAccumulate<Error>) () -> A): Value<A> { | ||
| contract { callsInPlace(block, AT_MOST_ONCE) } | ||
| return raise.accumulating { block() } | ||
| } | ||
|
|
||
| @JvmName("accumulateContextMap") | ||
| context(raise: Accumulate<Error>) | ||
| @RaiseDSL | ||
| public inline fun <Error, A, B> Iterable<A>.mapOrAccumulate( | ||
| transform: context(RaiseAccumulate<Error>) (A) -> B | ||
| ): Value<List<B>> = raise.accumulating { | ||
| this@mapOrAccumulate.mapOrAccumulate(transform) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about this one. It has a different return type from the
RaiseAccumulateoverload.There's definitely a use for it, just unsure about the name.
Accumulate is basically a delayed
Raise(which lets it accumulate errors), so the convention usually is thatXOrAccumulatemethods returnValue.mapOrAccumulatepredates that conventino. It's ought to be calledmapAccumulatinglikeforEachAccumulating, but that's an annoying name change to go through.(Maybe the opposite convention could work? and then
forEachAccumulatingis just the odd one out? AllValue-returning functions are still experimental, so we could change them...)mapOrAccumulateis a good name for this operation, but it means someone usingRaiseAccumulatevs justAccumulategets very different behavior. I suggest we leave it to another PR maybe?