kotlin-result/README.md

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:

• Elm
• Haskell
• Rust

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

• kotlin-result
• Result

Improvements on the existing solutions include:

• Relaxed constraints on nullable types (both the value and error can be typed as nullable)
• Relaxed constraints on the error type to 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

Installation

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'
}