https://github.com/sczerwinski/kotlin-util

Kotlin utility types based on Scala
https://github.com/sczerwinski/kotlin-util

either kotlin kotlin-library option try

Last synced: 2 months ago
JSON representation

Kotlin utility types based on Scala

• Host: GitHub
• URL: https://github.com/sczerwinski/kotlin-util
• Owner: sczerwinski
• License: apache-2.0
• Created: 2018-04-06T08:52:55.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T13:14:52.000Z (3 months ago)
• Last Synced: 2024-10-02T03:02:47.356Z (3 months ago)
• Topics: either, kotlin, kotlin-library, option, try
• Language: Kotlin
• Homepage: https://czerwinski.it/projects/kotlin-util/
• Size: 630 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build](https://github.com/sczerwinski/kotlin-util/workflows/Build/badge.svg)](https://github.com/sczerwinski/kotlin-util/actions)

![Kotlin Multiplatform](https://img.shields.io/badge/Kotlin-Multiplatform-blueviolet)  

[![Release](https://github.com/sczerwinski/kotlin-util/workflows/Release/badge.svg)](https://github.com/sczerwinski/kotlin-util/actions)

[![Maven Central](https://img.shields.io/maven-central/v/it.czerwinski/kotlin-util.svg)](https://repo1.maven.org/maven2/it/czerwinski/kotlin-util/)

[![Sonatype Snapshot](https://img.shields.io/nexus/s/https/oss.sonatype.org/it.czerwinski/kotlin-util.svg)](https://oss.sonatype.org/content/repositories/snapshots/it/czerwinski/kotlin-util/)

# ![icon.svg](.idea/icon.svg) Kotlin Utilities

## Project Setup

### Gradle

#### Kotlin

```kotlin

implementation("it.czerwinski:kotlin-util:2.0.0")

```

#### Groovy

```groovy

implementation 'it.czerwinski:kotlin-util:2.0.0'

```

### Maven

```xml

  it.czerwinski

  kotlin-util

  2.0.0

```

### Kotlin Multiplatform Projects

In multiplatform projects, the library can be used as `commonMain` dependency.

### Java Modules (JPMS)

In projects using Java Modules (JPMS), add the following line

to your `module-info.java`:

```java

module your.module {

    requires it.czerwinski.kotlin.util;

}

```

## Supported Types

Package `it.czerwinski.kotlin.collections`:

* `EmptyIterator`

* `SingletonIterator`

Package `it.czerwinski.kotlin.util`:

* `Option`

* `Either`

* `Try`

For a more detailed documentation, visit

[project website](https://czerwinski.it/projects/kotlin-util/).