A multiplatform Result monad for modelling success or failure operations.

Go to file

Michael Bull 2e2fc22b2b Add release/publish configuration		2017-10-21 22:33:59 +01:00
gradle	Add release/publish configuration	2017-10-21 22:33:59 +01:00
src	Add inline documentation to library methods	2017-10-21 21:19:21 +01:00
.editorconfig	Initial commit	2017-10-21 03:51:30 +01:00
.gitignore	Initial commit	2017-10-21 03:51:30 +01:00
LICENSE	Initial commit	2017-10-21 03:51:30 +01:00
README.md	Add release/publish configuration	2017-10-21 22:33:59 +01:00
build.gradle	Add release/publish configuration	2017-10-21 22:33:59 +01:00
gradle.properties	Add README	2017-10-21 17:44:55 +01:00
gradlew	Initial commit	2017-10-21 03:51:30 +01:00
gradlew.bat	Initial commit	2017-10-21 03:51:30 +01:00
settings.gradle	Initial commit	2017-10-21 03:51:30 +01:00

kotlin-result

Result<V, E> is a monad for modelling success (Ok) or failure (Error) operations.

Inspiration

Inspiration for this library has been drawn from other languages in which the Result monad is present, including:

It also iterates on other Result libraries written in Kotlin, namely:

Improvements on the existing solutions include:

Feature parity with Result types from other languages including Elm, Haskell, & Rust
Lax constraints on value/error nullability
Lax constraints on the error type's inheritance (does not inherit from Exception)
Top level Ok and Error classes avoids qualifying usages with Result.Ok/Result.Error respectively
Higher-order functions marked with the inline keyword for reduced runtime overhead
Extension functions on Iterable & List for folding, combining, partitioning
Consistent naming with existing Result libraries from other languages (e.g. map, mapError, mapBoth, mapEither, and, andThen, or, orElse, unwrap)
Extensive test suite with over 50 unit tests and every library method covered

This project is available in the Maven Central Repository repository. The artifacts are signed with my personal GPG key.

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.mikebull94.kotlin-result:kotlin-result:1.0.0'
}

The unit tests are a good source of examples for using the library as they cover every available method.

Mappings from common Result libraries are available on the wiki:

Bug reports and pull requests are welcome on GitHub.

This project is available under the terms of the ISC license. See the LICENSE file for the copyright information and licensing terms.