Λrrow is a library for Typed Functional Programming in Kotlin.
It includes the most popular data types, type classes and abstractions such as Option
, Try
, Either
, IO
, Functor
, Applicative
, Monad
and many more empowering users to define pure FP apps and libraries built atop higher order abstractions. Use the below list to learn more about Λrrow's main features.
- Documentation
- Patterns: tutorials and approaches to day-to-day challenges using FP
- Libraries: all the libraries provided by Λrrow
- Type classes: defining behaviors for data
- Data types: common abstractions
- Effects: interfacing with external systems
- Optics: inspecting and modifying data structures
Curated external links
Basic Setup
Make sure to have the latest version of JDK 1.8 installed.
Add it in your root build.gradle
at the end of repositories.
allprojects {
repositories {
jcenter()
}
}
Add the dependencies into the project's build.gradle
dependencies {
compile 'io.arrow-kt:arrow-core:0.7.2'
compile 'io.arrow-kt:arrow-syntax:0.7.2'
compile 'io.arrow-kt:arrow-typeclasses:0.7.2'
compile 'io.arrow-kt:arrow-data:0.7.2'
compile 'io.arrow-kt:arrow-instances-core:0.7.2'
compile 'io.arrow-kt:arrow-instances-data:0.7.2'
kapt 'io.arrow-kt:arrow-annotations-processor:0.7.2'
compile 'io.arrow-kt:arrow-free:0.7.2' //optional
compile 'io.arrow-kt:arrow-mtl:0.7.2' //optional
compile 'io.arrow-kt:arrow-effects:0.7.2' //optional
compile 'io.arrow-kt:arrow-effects-rx2:0.7.2' //optional
compile 'io.arrow-kt:arrow-effects-reactor:0.7.2' //optional
compile 'io.arrow-kt:arrow-effects-kotlinx-coroutines:0.7.2' //optional
compile 'io.arrow-kt:arrow-optics:0.7.2' //optional
compile 'io.arrow-kt:arrow-generic:0.7.2' //optional
compile 'io.arrow-kt:arrow-recursion:0.7.2' //optional
}
Additional Setup
For projects that wish to use their own @higherkind
, @optics
and other meta programming facilities provided by Λrrow
the setup below is also required:
Add the dependencies into the project's build.gradle
apply plugin: 'kotlin-kapt' //optional
apply from: rootProject.file('gradle/generated-kotlin-sources.gradle') //optional
dependencies {
...
kapt 'io.arrow-kt:arrow-annotations-processor:0.7.2' //optional
...
}
JVM projects:
gradle/generated-kotlin-sources.gradle
apply plugin: 'idea'
idea {
module {
sourceDirs += files(
'build/generated/source/kapt/main',
'build/generated/source/kaptKotlin/main',
'build/tmp/kapt/main/kotlinGenerated')
generatedSourceDirs += files(
'build/generated/source/kapt/main',
'build/generated/source/kaptKotlin/main',
'build/tmp/kapt/main/kotlinGenerated')
}
}
Android projects:
gradle/generated-kotlin-sources.gradle
apply plugin: 'idea'
idea {
module {
sourceDirs += files(
'build/generated/source/kapt/main',
'build/generated/source/kapt/debug',
'build/generated/source/kapt/release',
'build/generated/source/kaptKotlin/main',
'build/generated/source/kaptKotlin/debug',
'build/generated/source/kaptKotlin/release',
'build/tmp/kapt/main/kotlinGenerated')
generatedSourceDirs += files(
'build/generated/source/kapt/main',
'build/generated/source/kapt/debug',
'build/generated/source/kapt/release',
'build/generated/source/kaptKotlin/main',
'build/generated/source/kaptKotlin/debug',
'build/generated/source/kaptKotlin/release',
'build/tmp/kapt/main/kotlinGenerated')
}
}
License
Copyright (C) 2017 The Λrrow Authors
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.